pulumi-azure-native-kotlin/com.pulumi.azurenative.keyvault.kotlin/Vault

Vault

class Vault : KotlinCustomResource

Resource information with extended details. Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2023-02-01, 2023-07-01, 2024-04-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native keyvault [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create a new vault or update an existing vault

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var vault = new AzureNative.KeyVault.Vault("vault", new()
    {
        Location = "westus",
        Properties = new AzureNative.KeyVault.Inputs.VaultPropertiesArgs
        {
            AccessPolicies = new[]
            {
                new AzureNative.KeyVault.Inputs.AccessPolicyEntryArgs
                {
                    ObjectId = "00000000-0000-0000-0000-000000000000",
                    Permissions = new AzureNative.KeyVault.Inputs.PermissionsArgs
                    {
                        Certificates = new[]
                        {
                            AzureNative.KeyVault.CertificatePermissions.@Get,
                            AzureNative.KeyVault.CertificatePermissions.List,
                            AzureNative.KeyVault.CertificatePermissions.Delete,
                            AzureNative.KeyVault.CertificatePermissions.Create,
                            AzureNative.KeyVault.CertificatePermissions.Import,
                            AzureNative.KeyVault.CertificatePermissions.Update,
                            AzureNative.KeyVault.CertificatePermissions.Managecontacts,
                            AzureNative.KeyVault.CertificatePermissions.Getissuers,
                            AzureNative.KeyVault.CertificatePermissions.Listissuers,
                            AzureNative.KeyVault.CertificatePermissions.Setissuers,
                            AzureNative.KeyVault.CertificatePermissions.Deleteissuers,
                            AzureNative.KeyVault.CertificatePermissions.Manageissuers,
                            AzureNative.KeyVault.CertificatePermissions.Recover,
                            AzureNative.KeyVault.CertificatePermissions.Purge,
                        },
                        Keys = new[]
                        {
                            AzureNative.KeyVault.KeyPermissions.Encrypt,
                            AzureNative.KeyVault.KeyPermissions.Decrypt,
                            AzureNative.KeyVault.KeyPermissions.WrapKey,
                            AzureNative.KeyVault.KeyPermissions.UnwrapKey,
                            AzureNative.KeyVault.KeyPermissions.Sign,
                            AzureNative.KeyVault.KeyPermissions.Verify,
                            AzureNative.KeyVault.KeyPermissions.@Get,
                            AzureNative.KeyVault.KeyPermissions.List,
                            AzureNative.KeyVault.KeyPermissions.Create,
                            AzureNative.KeyVault.KeyPermissions.Update,
                            AzureNative.KeyVault.KeyPermissions.Import,
                            AzureNative.KeyVault.KeyPermissions.Delete,
                            AzureNative.KeyVault.KeyPermissions.Backup,
                            AzureNative.KeyVault.KeyPermissions.Restore,
                            AzureNative.KeyVault.KeyPermissions.Recover,
                            AzureNative.KeyVault.KeyPermissions.Purge,
                        },
                        Secrets = new[]
                        {
                            AzureNative.KeyVault.SecretPermissions.@Get,
                            AzureNative.KeyVault.SecretPermissions.List,
                            AzureNative.KeyVault.SecretPermissions.@Set,
                            AzureNative.KeyVault.SecretPermissions.Delete,
                            AzureNative.KeyVault.SecretPermissions.Backup,
                            AzureNative.KeyVault.SecretPermissions.Restore,
                            AzureNative.KeyVault.SecretPermissions.Recover,
                            AzureNative.KeyVault.SecretPermissions.Purge,
                        },
                    },
                    TenantId = "00000000-0000-0000-0000-000000000000",
                },
            },
            EnabledForDeployment = true,
            EnabledForDiskEncryption = true,
            EnabledForTemplateDeployment = true,
            PublicNetworkAccess = "Enabled",
            Sku = new AzureNative.KeyVault.Inputs.SkuArgs
            {
                Family = AzureNative.KeyVault.SkuFamily.A,
                Name = AzureNative.KeyVault.SkuName.Standard,
            },
            TenantId = "00000000-0000-0000-0000-000000000000",
        },
        ResourceGroupName = "sample-resource-group",
        VaultName = "sample-vault",
    });
});
Content copied to clipboard
package main
import (
	keyvault "github.com/pulumi/pulumi-azure-native-sdk/keyvault/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := keyvault.NewVault(ctx, "vault", &keyvault.VaultArgs{
			Location: pulumi.String("westus"),
			Properties: &keyvault.VaultPropertiesArgs{
				AccessPolicies: keyvault.AccessPolicyEntryArray{
					&keyvault.AccessPolicyEntryArgs{
						ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
						Permissions: &keyvault.PermissionsArgs{
							Certificates: pulumi.StringArray{
								pulumi.String(keyvault.CertificatePermissionsGet),
								pulumi.String(keyvault.CertificatePermissionsList),
								pulumi.String(keyvault.CertificatePermissionsDelete),
								pulumi.String(keyvault.CertificatePermissionsCreate),
								pulumi.String(keyvault.CertificatePermissionsImport),
								pulumi.String(keyvault.CertificatePermissionsUpdate),
								pulumi.String(keyvault.CertificatePermissionsManagecontacts),
								pulumi.String(keyvault.CertificatePermissionsGetissuers),
								pulumi.String(keyvault.CertificatePermissionsListissuers),
								pulumi.String(keyvault.CertificatePermissionsSetissuers),
								pulumi.String(keyvault.CertificatePermissionsDeleteissuers),
								pulumi.String(keyvault.CertificatePermissionsManageissuers),
								pulumi.String(keyvault.CertificatePermissionsRecover),
								pulumi.String(keyvault.CertificatePermissionsPurge),
							},
							Keys: pulumi.StringArray{
								pulumi.String(keyvault.KeyPermissionsEncrypt),
								pulumi.String(keyvault.KeyPermissionsDecrypt),
								pulumi.String(keyvault.KeyPermissionsWrapKey),
								pulumi.String(keyvault.KeyPermissionsUnwrapKey),
								pulumi.String(keyvault.KeyPermissionsSign),
								pulumi.String(keyvault.KeyPermissionsVerify),
								pulumi.String(keyvault.KeyPermissionsGet),
								pulumi.String(keyvault.KeyPermissionsList),
								pulumi.String(keyvault.KeyPermissionsCreate),
								pulumi.String(keyvault.KeyPermissionsUpdate),
								pulumi.String(keyvault.KeyPermissionsImport),
								pulumi.String(keyvault.KeyPermissionsDelete),
								pulumi.String(keyvault.KeyPermissionsBackup),
								pulumi.String(keyvault.KeyPermissionsRestore),
								pulumi.String(keyvault.KeyPermissionsRecover),
								pulumi.String(keyvault.KeyPermissionsPurge),
							},
							Secrets: pulumi.StringArray{
								pulumi.String(keyvault.SecretPermissionsGet),
								pulumi.String(keyvault.SecretPermissionsList),
								pulumi.String(keyvault.SecretPermissionsSet),
								pulumi.String(keyvault.SecretPermissionsDelete),
								pulumi.String(keyvault.SecretPermissionsBackup),
								pulumi.String(keyvault.SecretPermissionsRestore),
								pulumi.String(keyvault.SecretPermissionsRecover),
								pulumi.String(keyvault.SecretPermissionsPurge),
							},
						},
						TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
					},
				},
				EnabledForDeployment:         pulumi.Bool(true),
				EnabledForDiskEncryption:     pulumi.Bool(true),
				EnabledForTemplateDeployment: pulumi.Bool(true),
				PublicNetworkAccess:          pulumi.String("Enabled"),
				Sku: &keyvault.SkuArgs{
					Family: pulumi.String(keyvault.SkuFamilyA),
					Name:   keyvault.SkuNameStandard,
				},
				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			ResourceGroupName: pulumi.String("sample-resource-group"),
			VaultName:         pulumi.String("sample-vault"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.keyvault.Vault;
import com.pulumi.azurenative.keyvault.VaultArgs;
import com.pulumi.azurenative.keyvault.inputs.VaultPropertiesArgs;
import com.pulumi.azurenative.keyvault.inputs.SkuArgs;
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 vault = new Vault("vault", VaultArgs.builder()
            .location("westus")
            .properties(VaultPropertiesArgs.builder()
                .accessPolicies(AccessPolicyEntryArgs.builder()
                    .objectId("00000000-0000-0000-0000-000000000000")
                    .permissions(PermissionsArgs.builder()
                        .certificates(
                            "get",
                            "list",
                            "delete",
                            "create",
                            "import",
                            "update",
                            "managecontacts",
                            "getissuers",
                            "listissuers",
                            "setissuers",
                            "deleteissuers",
                            "manageissuers",
                            "recover",
                            "purge")
                        .keys(
                            "encrypt",
                            "decrypt",
                            "wrapKey",
                            "unwrapKey",
                            "sign",
                            "verify",
                            "get",
                            "list",
                            "create",
                            "update",
                            "import",
                            "delete",
                            "backup",
                            "restore",
                            "recover",
                            "purge")
                        .secrets(
                            "get",
                            "list",
                            "set",
                            "delete",
                            "backup",
                            "restore",
                            "recover",
                            "purge")
                        .build())
                    .tenantId("00000000-0000-0000-0000-000000000000")
                    .build())
                .enabledForDeployment(true)
                .enabledForDiskEncryption(true)
                .enabledForTemplateDeployment(true)
                .publicNetworkAccess("Enabled")
                .sku(SkuArgs.builder()
                    .family("A")
                    .name("standard")
                    .build())
                .tenantId("00000000-0000-0000-0000-000000000000")
                .build())
            .resourceGroupName("sample-resource-group")
            .vaultName("sample-vault")
            .build());
    }
}
Content copied to clipboard

Create or update a vault with network acls

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var vault = new AzureNative.KeyVault.Vault("vault", new()
    {
        Location = "westus",
        Properties = new AzureNative.KeyVault.Inputs.VaultPropertiesArgs
        {
            EnabledForDeployment = true,
            EnabledForDiskEncryption = true,
            EnabledForTemplateDeployment = true,
            NetworkAcls = new AzureNative.KeyVault.Inputs.NetworkRuleSetArgs
            {
                Bypass = AzureNative.KeyVault.NetworkRuleBypassOptions.AzureServices,
                DefaultAction = AzureNative.KeyVault.NetworkRuleAction.Deny,
                IpRules = new[]
                {
                    new AzureNative.KeyVault.Inputs.IPRuleArgs
                    {
                        Value = "124.56.78.91",
                    },
                    new AzureNative.KeyVault.Inputs.IPRuleArgs
                    {
                        Value = "'10.91.4.0/24'",
                    },
                },
                VirtualNetworkRules = new[]
                {
                    new AzureNative.KeyVault.Inputs.VirtualNetworkRuleArgs
                    {
                        Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1",
                    },
                },
            },
            Sku = new AzureNative.KeyVault.Inputs.SkuArgs
            {
                Family = AzureNative.KeyVault.SkuFamily.A,
                Name = AzureNative.KeyVault.SkuName.Standard,
            },
            TenantId = "00000000-0000-0000-0000-000000000000",
        },
        ResourceGroupName = "sample-resource-group",
        VaultName = "sample-vault",
    });
});
Content copied to clipboard
package main
import (
	keyvault "github.com/pulumi/pulumi-azure-native-sdk/keyvault/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := keyvault.NewVault(ctx, "vault", &keyvault.VaultArgs{
			Location: pulumi.String("westus"),
			Properties: &keyvault.VaultPropertiesArgs{
				EnabledForDeployment:         pulumi.Bool(true),
				EnabledForDiskEncryption:     pulumi.Bool(true),
				EnabledForTemplateDeployment: pulumi.Bool(true),
				NetworkAcls: &keyvault.NetworkRuleSetArgs{
					Bypass:        pulumi.String(keyvault.NetworkRuleBypassOptionsAzureServices),
					DefaultAction: pulumi.String(keyvault.NetworkRuleActionDeny),
					IpRules: keyvault.IPRuleArray{
						&keyvault.IPRuleArgs{
							Value: pulumi.String("124.56.78.91"),
						},
						&keyvault.IPRuleArgs{
							Value: pulumi.String("'10.91.4.0/24'"),
						},
					},
					VirtualNetworkRules: keyvault.VirtualNetworkRuleArray{
						&keyvault.VirtualNetworkRuleArgs{
							Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"),
						},
					},
				},
				Sku: &keyvault.SkuArgs{
					Family: pulumi.String(keyvault.SkuFamilyA),
					Name:   keyvault.SkuNameStandard,
				},
				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			ResourceGroupName: pulumi.String("sample-resource-group"),
			VaultName:         pulumi.String("sample-vault"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.keyvault.Vault;
import com.pulumi.azurenative.keyvault.VaultArgs;
import com.pulumi.azurenative.keyvault.inputs.VaultPropertiesArgs;
import com.pulumi.azurenative.keyvault.inputs.NetworkRuleSetArgs;
import com.pulumi.azurenative.keyvault.inputs.SkuArgs;
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 vault = new Vault("vault", VaultArgs.builder()
            .location("westus")
            .properties(VaultPropertiesArgs.builder()
                .enabledForDeployment(true)
                .enabledForDiskEncryption(true)
                .enabledForTemplateDeployment(true)
                .networkAcls(NetworkRuleSetArgs.builder()
                    .bypass("AzureServices")
                    .defaultAction("Deny")
                    .ipRules(
                        IPRuleArgs.builder()
                            .value("124.56.78.91")
                            .build(),
                        IPRuleArgs.builder()
                            .value("'10.91.4.0/24'")
                            .build())
                    .virtualNetworkRules(VirtualNetworkRuleArgs.builder()
                        .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1")
                        .build())
                    .build())
                .sku(SkuArgs.builder()
                    .family("A")
                    .name("standard")
                    .build())
                .tenantId("00000000-0000-0000-0000-000000000000")
                .build())
            .resourceGroupName("sample-resource-group")
            .vaultName("sample-vault")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:keyvault:Vault sample-vault /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
Content copied to clipboard

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>?

Azure location of the key vault resource.

Link copied to clipboard
val name: Output<String>

Name of the key vault resource.

Link copied to clipboard
val properties: Output<VaultPropertiesResponse>

Properties of the vault

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val systemData: Output<SystemDataResponse>

System metadata for the key vault.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Tags assigned to the key vault resource.

Link copied to clipboard
val type: Output<String>

Resource type of the key vault resource.

Link copied to clipboard
val urn: Output<String>