1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. keyvault
  6. Secret

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.keyvault.Secret

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Key Vault Secret.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new Azure.KeyVault.KeyVaultArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            TenantId = current.Apply(current => current.TenantId),
            SkuName = "premium",
            SoftDeleteRetentionDays = 7,
            AccessPolicies = 
            {
                new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
                {
                    TenantId = current.Apply(current => current.TenantId),
                    ObjectId = current.Apply(current => current.ObjectId),
                    KeyPermissions = 
                    {
                        "create",
                        "get",
                    },
                    SecretPermissions = 
                    {
                        "set",
                        "get",
                        "delete",
                        "purge",
                        "recover",
                    },
                },
            },
        });
        var exampleSecret = new Azure.KeyVault.Secret("exampleSecret", new Azure.KeyVault.SecretArgs
        {
            Value = "szechuan",
            KeyVaultId = exampleKeyVault.Id,
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/keyvault"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
			Location:                exampleResourceGroup.Location,
			ResourceGroupName:       exampleResourceGroup.Name,
			TenantId:                pulumi.String(current.TenantId),
			SkuName:                 pulumi.String("premium"),
			SoftDeleteRetentionDays: pulumi.Int(7),
			AccessPolicies: keyvault.KeyVaultAccessPolicyArray{
				&keyvault.KeyVaultAccessPolicyArgs{
					TenantId: pulumi.String(current.TenantId),
					ObjectId: pulumi.String(current.ObjectId),
					KeyPermissions: pulumi.StringArray{
						pulumi.String("create"),
						pulumi.String("get"),
					},
					SecretPermissions: pulumi.StringArray{
						pulumi.String("set"),
						pulumi.String("get"),
						pulumi.String("delete"),
						pulumi.String("purge"),
						pulumi.String("recover"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = keyvault.NewSecret(ctx, "exampleSecret", &keyvault.SecretArgs{
			Value:      pulumi.String("szechuan"),
			KeyVaultId: exampleKeyVault.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "premium",
    softDeleteRetentionDays: 7,
    accessPolicies: [{
        tenantId: current.then(current => current.tenantId),
        objectId: current.then(current => current.objectId),
        keyPermissions: [
            "create",
            "get",
        ],
        secretPermissions: [
            "set",
            "get",
            "delete",
            "purge",
            "recover",
        ],
    }],
});
const exampleSecret = new azure.keyvault.Secret("exampleSecret", {
    value: "szechuan",
    keyVaultId: exampleKeyVault.id,
});

    import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tenant_id=current.tenant_id,
    sku_name="premium",
    soft_delete_retention_days=7,
    access_policies=[azure.keyvault.KeyVaultAccessPolicyArgs(
        tenant_id=current.tenant_id,
        object_id=current.object_id,
        key_permissions=[
            "create",
            "get",
        ],
        secret_permissions=[
            "set",
            "get",
            "delete",
            "purge",
            "recover",
        ],
    )])
example_secret = azure.keyvault.Secret("exampleSecret",
    value="szechuan",
    key_vault_id=example_key_vault.id)

    Example coming soon!

    Create Secret Resource

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

    Constructor syntax

    new Secret(name: string, args: SecretArgs, opts?: CustomResourceOptions);
    @overload
def Secret(resource_name: str,
           args: SecretArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Secret(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           key_vault_id: Optional[str] = None,
           value: Optional[str] = None,
           content_type: Optional[str] = None,
           expiration_date: Optional[str] = None,
           name: Optional[str] = None,
           not_before_date: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None)
    func NewSecret(ctx *Context, name string, args SecretArgs, opts ...ResourceOption) (*Secret, error)
    public Secret(string name, SecretArgs args, CustomResourceOptions? opts = null)
    public Secret(String name, SecretArgs args)
public Secret(String name, SecretArgs args, CustomResourceOptions options)

    type: azure:keyvault:Secret
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 SecretArgs
    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 SecretArgs
    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 SecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretArgs
    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 secretResource = new Azure.KeyVault.Secret("secretResource", new()
{
    KeyVaultId = "string",
    Value = "string",
    ContentType = "string",
    ExpirationDate = "string",
    Name = "string",
    NotBeforeDate = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := keyvault.NewSecret(ctx, "secretResource", &keyvault.SecretArgs{
	KeyVaultId:     pulumi.String("string"),
	Value:          pulumi.String("string"),
	ContentType:    pulumi.String("string"),
	ExpirationDate: pulumi.String("string"),
	Name:           pulumi.String("string"),
	NotBeforeDate:  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var secretResource = new Secret("secretResource", SecretArgs.builder()
    .keyVaultId("string")
    .value("string")
    .contentType("string")
    .expirationDate("string")
    .name("string")
    .notBeforeDate("string")
    .tags(Map.of("string", "string"))
    .build());

    secret_resource = azure.keyvault.Secret("secretResource",
    key_vault_id="string",
    value="string",
    content_type="string",
    expiration_date="string",
    name="string",
    not_before_date="string",
    tags={
        "string": "string",
    })

    const secretResource = new azure.keyvault.Secret("secretResource", {
    keyVaultId: "string",
    value: "string",
    contentType: "string",
    expirationDate: "string",
    name: "string",
    notBeforeDate: "string",
    tags: {
        string: "string",
    },
});

    type: azure:keyvault:Secret
properties:
    contentType: string
    expirationDate: string
    keyVaultId: string
    name: string
    notBeforeDate: string
    tags:
        string: string
    value: string

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

    KeyVaultId string
    The ID of the Key Vault where the Secret should be created.
    Value string
    Specifies the value of the Key Vault Secret.
    ContentType string
    Specifies the content type for the Key Vault Secret.
    ExpirationDate string
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    Name string
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    NotBeforeDate string
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    KeyVaultId string
    The ID of the Key Vault where the Secret should be created.
    Value string
    Specifies the value of the Key Vault Secret.
    ContentType string
    Specifies the content type for the Key Vault Secret.
    ExpirationDate string
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    Name string
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    NotBeforeDate string
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    Tags map[string]string
    A mapping of tags to assign to the resource.
    keyVaultId String
    The ID of the Key Vault where the Secret should be created.
    value String
    Specifies the value of the Key Vault Secret.
    contentType String
    Specifies the content type for the Key Vault Secret.
    expirationDate String
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    name String
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    notBeforeDate String
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    keyVaultId string
    The ID of the Key Vault where the Secret should be created.
    value string
    Specifies the value of the Key Vault Secret.
    contentType string
    Specifies the content type for the Key Vault Secret.
    expirationDate string
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    name string
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    notBeforeDate string
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    key_vault_id str
    The ID of the Key Vault where the Secret should be created.
    value str
    Specifies the value of the Key Vault Secret.
    content_type str
    Specifies the content type for the Key Vault Secret.
    expiration_date str
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    name str
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    not_before_date str
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    keyVaultId String
    The ID of the Key Vault where the Secret should be created.
    value String
    Specifies the value of the Key Vault Secret.
    contentType String
    Specifies the content type for the Key Vault Secret.
    expirationDate String
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    name String
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    notBeforeDate String
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version string
    The current version of the Key Vault Secret.
    VersionlessId string
    The Base ID of the Key Vault Secret.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version string
    The current version of the Key Vault Secret.
    VersionlessId string
    The Base ID of the Key Vault Secret.
    id String
    The provider-assigned unique ID for this managed resource.
    version String
    The current version of the Key Vault Secret.
    versionlessId String
    The Base ID of the Key Vault Secret.
    id string
    The provider-assigned unique ID for this managed resource.
    version string
    The current version of the Key Vault Secret.
    versionlessId string
    The Base ID of the Key Vault Secret.
    id str
    The provider-assigned unique ID for this managed resource.
    version str
    The current version of the Key Vault Secret.
    versionless_id str
    The Base ID of the Key Vault Secret.
    id String
    The provider-assigned unique ID for this managed resource.
    version String
    The current version of the Key Vault Secret.
    versionlessId String
    The Base ID of the Key Vault Secret.

    Look up Existing Secret Resource

    Get an existing Secret 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?: SecretState, opts?: CustomResourceOptions): Secret
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content_type: Optional[str] = None,
        expiration_date: Optional[str] = None,
        key_vault_id: Optional[str] = None,
        name: Optional[str] = None,
        not_before_date: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        value: Optional[str] = None,
        version: Optional[str] = None,
        versionless_id: Optional[str] = None) -> Secret
    func GetSecret(ctx *Context, name string, id IDInput, state *SecretState, opts ...ResourceOption) (*Secret, error)
    public static Secret Get(string name, Input<string> id, SecretState? state, CustomResourceOptions? opts = null)
    public static Secret get(String name, Output<String> id, SecretState state, CustomResourceOptions options)
    resources:  _:    type: azure:keyvault:Secret    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.
    The following state arguments are supported:
    ContentType string
    Specifies the content type for the Key Vault Secret.
    ExpirationDate string
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    KeyVaultId string
    The ID of the Key Vault where the Secret should be created.
    Name string
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    NotBeforeDate string
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Value string
    Specifies the value of the Key Vault Secret.
    Version string
    The current version of the Key Vault Secret.
    VersionlessId string
    The Base ID of the Key Vault Secret.
    ContentType string
    Specifies the content type for the Key Vault Secret.
    ExpirationDate string
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    KeyVaultId string
    The ID of the Key Vault where the Secret should be created.
    Name string
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    NotBeforeDate string
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Value string
    Specifies the value of the Key Vault Secret.
    Version string
    The current version of the Key Vault Secret.
    VersionlessId string
    The Base ID of the Key Vault Secret.
    contentType String
    Specifies the content type for the Key Vault Secret.
    expirationDate String
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    keyVaultId String
    The ID of the Key Vault where the Secret should be created.
    name String
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    notBeforeDate String
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    value String
    Specifies the value of the Key Vault Secret.
    version String
    The current version of the Key Vault Secret.
    versionlessId String
    The Base ID of the Key Vault Secret.
    contentType string
    Specifies the content type for the Key Vault Secret.
    expirationDate string
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    keyVaultId string
    The ID of the Key Vault where the Secret should be created.
    name string
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    notBeforeDate string
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    value string
    Specifies the value of the Key Vault Secret.
    version string
    The current version of the Key Vault Secret.
    versionlessId string
    The Base ID of the Key Vault Secret.
    content_type str
    Specifies the content type for the Key Vault Secret.
    expiration_date str
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    key_vault_id str
    The ID of the Key Vault where the Secret should be created.
    name str
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    not_before_date str
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    value str
    Specifies the value of the Key Vault Secret.
    version str
    The current version of the Key Vault Secret.
    versionless_id str
    The Base ID of the Key Vault Secret.
    contentType String
    Specifies the content type for the Key Vault Secret.
    expirationDate String
    Expiration UTC datetime (Y-m-d'T'H:M:S'Z').
    keyVaultId String
    The ID of the Key Vault where the Secret should be created.
    name String
    Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.
    notBeforeDate String
    Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').
    tags Map<String>
    A mapping of tags to assign to the resource.
    value String
    Specifies the value of the Key Vault Secret.
    version String
    The current version of the Key Vault Secret.
    versionlessId String
    The Base ID of the Key Vault Secret.

    Import

    Key Vault Secrets which are Enabled can be imported using the resource id, e.g.

     $ pulumi import azure:keyvault/secret:Secret example "https://example-keyvault.vault.azure.net/secrets/example/fdf067c93bbb4b22bff4d8b7a9a56217"

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.