GetKeyVault

Use this data source to access information about an existing Key Vault.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.KeyVault.GetKeyVault.InvokeAsync(new Azure.KeyVault.GetKeyVaultArgs
        {
            Name = "mykeyvault",
            ResourceGroupName = "some-resource-group",
        }));
        this.VaultUri = example.Apply(example => example.VaultUri);
    }

    [Output("vaultUri")]
    public Output<string> VaultUri { get; set; }
}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := keyvault.LookupKeyVault(ctx, &keyvault.LookupKeyVaultArgs{
            Name:              "mykeyvault",
            ResourceGroupName: "some-resource-group",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("vaultUri", example.VaultUri)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.keyvault.get_key_vault(name="mykeyvault",
    resource_group_name="some-resource-group")
pulumi.export("vaultUri", example.vault_uri)

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

const example = azure.keyvault.getKeyVault({
    name: "mykeyvault",
    resourceGroupName: "some-resource-group",
});
export const vaultUri = example.then(example => example.vaultUri);

Using GetKeyVault

function getKeyVault(args: GetKeyVaultArgs, opts?: InvokeOptions): Promise<GetKeyVaultResult>

function  get_key_vault(name=None, resource_group_name=None, opts=None)

func LookupKeyVault(ctx *Context, args *LookupKeyVaultArgs, opts ...InvokeOption) (*LookupKeyVaultResult, error)

Note: This function is named LookupKeyVault in the Go SDK.

public static class GetKeyVault {
    public static Task<GetKeyVaultResult> InvokeAsync(GetKeyVaultArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: Specifies the name of the Key Vault.
ResourceGroupName string: The name of the Resource Group in which the Key Vault exists.

Name string: Specifies the name of the Key Vault.
ResourceGroupName string: The name of the Resource Group in which the Key Vault exists.

name string: Specifies the name of the Key Vault.
resourceGroupName string: The name of the Resource Group in which the Key Vault exists.

name str: Specifies the name of the Key Vault.
resource_group_name str: The name of the Resource Group in which the Key Vault exists.

GetKeyVault Result

The following output properties are available:

AccessPolicies List<GetKeyVaultAccessPolicy>: One or more access_policy blocks as defined below.
EnabledForDeployment bool: Can Azure Virtual Machines retrieve certificates stored as secrets from the Key Vault?
EnabledForDiskEncryption bool: Can Azure Disk Encryption retrieve secrets from the Key Vault?
EnabledForTemplateDeployment bool: Can Azure Resource Manager retrieve secrets from the Key Vault?
Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure Region in which the Key Vault exists.
Name string
NetworkAcls List<GetKeyVaultNetworkAcl>
PurgeProtectionEnabled bool: Is purge protection enabled on this Key Vault?
ResourceGroupName string
SkuName string: The Name of the SKU used for this Key Vault.
SoftDeleteEnabled bool: Is soft delete enabled on this Key Vault?
Tags Dictionary<string, string>: A mapping of tags assigned to the Key Vault.
TenantId string: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.
VaultUri string: The URI of the vault for performing operations on keys and secrets.

AccessPolicies []GetKeyVaultAccessPolicy: One or more access_policy blocks as defined below.
EnabledForDeployment bool: Can Azure Virtual Machines retrieve certificates stored as secrets from the Key Vault?
EnabledForDiskEncryption bool: Can Azure Disk Encryption retrieve secrets from the Key Vault?
EnabledForTemplateDeployment bool: Can Azure Resource Manager retrieve secrets from the Key Vault?
Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure Region in which the Key Vault exists.
Name string
NetworkAcls []GetKeyVaultNetworkAcl
PurgeProtectionEnabled bool: Is purge protection enabled on this Key Vault?
ResourceGroupName string
SkuName string: The Name of the SKU used for this Key Vault.
SoftDeleteEnabled bool: Is soft delete enabled on this Key Vault?
Tags map[string]string: A mapping of tags assigned to the Key Vault.
TenantId string: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.
VaultUri string: The URI of the vault for performing operations on keys and secrets.

accessPolicies GetKeyVaultAccessPolicy[]: One or more access_policy blocks as defined below.
enabledForDeployment boolean: Can Azure Virtual Machines retrieve certificates stored as secrets from the Key Vault?
enabledForDiskEncryption boolean: Can Azure Disk Encryption retrieve secrets from the Key Vault?
enabledForTemplateDeployment boolean: Can Azure Resource Manager retrieve secrets from the Key Vault?
id string: The provider-assigned unique ID for this managed resource.
location string: The Azure Region in which the Key Vault exists.
name string
networkAcls GetKeyVaultNetworkAcl[]
purgeProtectionEnabled boolean: Is purge protection enabled on this Key Vault?
resourceGroupName string
skuName string: The Name of the SKU used for this Key Vault.
softDeleteEnabled boolean: Is soft delete enabled on this Key Vault?
tags {[key: string]: string}: A mapping of tags assigned to the Key Vault.
tenantId string: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.
vaultUri string: The URI of the vault for performing operations on keys and secrets.

access_policies List[GetKeyVaultAccessPolicy]: One or more access_policy blocks as defined below.
enabled_for_deployment bool: Can Azure Virtual Machines retrieve certificates stored as secrets from the Key Vault?
enabled_for_disk_encryption bool: Can Azure Disk Encryption retrieve secrets from the Key Vault?
enabled_for_template_deployment bool: Can Azure Resource Manager retrieve secrets from the Key Vault?
id str: The provider-assigned unique ID for this managed resource.
location str: The Azure Region in which the Key Vault exists.
name str
network_acls List[GetKeyVaultNetworkAcl]
purge_protection_enabled bool: Is purge protection enabled on this Key Vault?
resource_group_name str
sku_name str: The Name of the SKU used for this Key Vault.
soft_delete_enabled bool: Is soft delete enabled on this Key Vault?
tags Dict[str, str]: A mapping of tags assigned to the Key Vault.
tenant_id str: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.
vault_uri str: The URI of the vault for performing operations on keys and secrets.

Supporting Types

GetKeyVaultAccessPolicy

See the output API doc for this type.

ApplicationId string: The Object ID of a Azure Active Directory Application.
CertificatePermissions List<string>: A list of certificate permissions applicable to this Access Policy.
KeyPermissions List<string>: A list of key permissions applicable to this Access Policy.
ObjectId string: An Object ID of a User, Service Principal or Security Group.
SecretPermissions List<string>: A list of secret permissions applicable to this Access Policy.
StoragePermissions List<string>: A list of storage permissions applicable to this Access Policy.
TenantId string: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.

ApplicationId string: The Object ID of a Azure Active Directory Application.
CertificatePermissions []string: A list of certificate permissions applicable to this Access Policy.
KeyPermissions []string: A list of key permissions applicable to this Access Policy.
ObjectId string: An Object ID of a User, Service Principal or Security Group.
SecretPermissions []string: A list of secret permissions applicable to this Access Policy.
StoragePermissions []string: A list of storage permissions applicable to this Access Policy.
TenantId string: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.

applicationId string: The Object ID of a Azure Active Directory Application.
certificatePermissions string[]: A list of certificate permissions applicable to this Access Policy.
keyPermissions string[]: A list of key permissions applicable to this Access Policy.
objectId string: An Object ID of a User, Service Principal or Security Group.
secretPermissions string[]: A list of secret permissions applicable to this Access Policy.
storagePermissions string[]: A list of storage permissions applicable to this Access Policy.
tenantId string: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.

application_id str: The Object ID of a Azure Active Directory Application.
certificate_permissions List[str]: A list of certificate permissions applicable to this Access Policy.
key_permissions List[str]: A list of key permissions applicable to this Access Policy.
object_id str: An Object ID of a User, Service Principal or Security Group.
secret_permissions List[str]: A list of secret permissions applicable to this Access Policy.
storage_permissions List[str]: A list of storage permissions applicable to this Access Policy.
tenant_id str: The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.

GetKeyVaultNetworkAcl

See the output API doc for this type.

Bypass string
DefaultAction string
IpRules List<string>
VirtualNetworkSubnetIds List<string>

Bypass string
DefaultAction string
IpRules []string
VirtualNetworkSubnetIds []string

bypass string
defaultAction string
ipRules string[]
virtualNetworkSubnetIds string[]

bypass str
default_action str
ip_rules List[str]
virtual_network_subnet_ids List[str]

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetKeyVault

Example Usage

Using GetKeyVault

GetKeyVault Result

Supporting Types

GetKeyVaultAccessPolicy

GetKeyVaultNetworkAcl

Package Details

On This Page