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

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.getKey

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

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

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.KeyVault.GetKey.InvokeAsync(new Azure.KeyVault.GetKeyArgs
        {
            Name = "secret-sauce",
            KeyVaultId = data.Azurerm_key_vault.Existing.Id,
        }));
        this.KeyType = example.Apply(example => example.KeyType);
    }

    [Output("keyType")]
    public Output<string> KeyType { get; set; }
}

    package main

import (
	"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 {
		example, err := keyvault.LookupKey(ctx, &keyvault.LookupKeyArgs{
			Name:       "secret-sauce",
			KeyVaultId: data.Azurerm_key_vault.Existing.Id,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("keyType", example.KeyType)
		return nil
	})
}

    Example coming soon!

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

const example = azure.keyvault.getKey({
    name: "secret-sauce",
    keyVaultId: data.azurerm_key_vault.existing.id,
});
export const keyType = example.then(example => example.keyType);

    import pulumi
import pulumi_azure as azure

example = azure.keyvault.get_key(name="secret-sauce",
    key_vault_id=data["azurerm_key_vault"]["existing"]["id"])
pulumi.export("keyType", example.key_type)

    Example coming soon!

    Using getKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>
    def get_key(key_vault_id: Optional[str] = None,
            name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_vault_id: Optional[pulumi.Input[str]] = None,
            name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]
    func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

    > Note: This function is named LookupKey in the Go SDK.

    public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
public static Output<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:keyvault/getKey:getKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KeyVaultId string
    Specifies the ID of the Key Vault instance where the Secret resides, available on the azure.keyvault.KeyVault Data Source / Resource.
    Name string
    Specifies the name of the Key Vault Key.
    KeyVaultId string
    Specifies the ID of the Key Vault instance where the Secret resides, available on the azure.keyvault.KeyVault Data Source / Resource.
    Name string
    Specifies the name of the Key Vault Key.
    keyVaultId String
    Specifies the ID of the Key Vault instance where the Secret resides, available on the azure.keyvault.KeyVault Data Source / Resource.
    name String
    Specifies the name of the Key Vault Key.
    keyVaultId string
    Specifies the ID of the Key Vault instance where the Secret resides, available on the azure.keyvault.KeyVault Data Source / Resource.
    name string
    Specifies the name of the Key Vault Key.
    key_vault_id str
    Specifies the ID of the Key Vault instance where the Secret resides, available on the azure.keyvault.KeyVault Data Source / Resource.
    name str
    Specifies the name of the Key Vault Key.
    keyVaultId String
    Specifies the ID of the Key Vault instance where the Secret resides, available on the azure.keyvault.KeyVault Data Source / Resource.
    name String
    Specifies the name of the Key Vault Key.

    getKey Result

    The following output properties are available:

    Curve string
    The EC Curve name of this Key Vault Key.
    E string
    The RSA public exponent of this Key Vault Key.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyOpts List<string>
    A list of JSON web key operations assigned to this Key Vault Key
    KeySize int
    Specifies the Size of this Key Vault Key.
    KeyType string
    Specifies the Key Type of this Key Vault Key
    KeyVaultId string
    N string
    The RSA modulus of this Key Vault Key.
    Name string
    PublicKeyOpenssh string
    The OpenSSH encoded public key of this Key Vault Key.
    PublicKeyPem string
    The PEM encoded public key of this Key Vault Key.
    Tags Dictionary<string, string>
    A mapping of tags assigned to this Key Vault Key.
    Version string
    The current version of the Key Vault Key.
    VersionlessId string
    The Base ID of the Key Vault Key.
    X string
    The EC X component of this Key Vault Key.
    Y string
    The EC Y component of this Key Vault Key.
    Curve string
    The EC Curve name of this Key Vault Key.
    E string
    The RSA public exponent of this Key Vault Key.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyOpts []string
    A list of JSON web key operations assigned to this Key Vault Key
    KeySize int
    Specifies the Size of this Key Vault Key.
    KeyType string
    Specifies the Key Type of this Key Vault Key
    KeyVaultId string
    N string
    The RSA modulus of this Key Vault Key.
    Name string
    PublicKeyOpenssh string
    The OpenSSH encoded public key of this Key Vault Key.
    PublicKeyPem string
    The PEM encoded public key of this Key Vault Key.
    Tags map[string]string
    A mapping of tags assigned to this Key Vault Key.
    Version string
    The current version of the Key Vault Key.
    VersionlessId string
    The Base ID of the Key Vault Key.
    X string
    The EC X component of this Key Vault Key.
    Y string
    The EC Y component of this Key Vault Key.
    curve String
    The EC Curve name of this Key Vault Key.
    e String
    The RSA public exponent of this Key Vault Key.
    id String
    The provider-assigned unique ID for this managed resource.
    keyOpts List<String>
    A list of JSON web key operations assigned to this Key Vault Key
    keySize Integer
    Specifies the Size of this Key Vault Key.
    keyType String
    Specifies the Key Type of this Key Vault Key
    keyVaultId String
    n String
    The RSA modulus of this Key Vault Key.
    name String
    publicKeyOpenssh String
    The OpenSSH encoded public key of this Key Vault Key.
    publicKeyPem String
    The PEM encoded public key of this Key Vault Key.
    tags Map<String,String>
    A mapping of tags assigned to this Key Vault Key.
    version String
    The current version of the Key Vault Key.
    versionlessId String
    The Base ID of the Key Vault Key.
    x String
    The EC X component of this Key Vault Key.
    y String
    The EC Y component of this Key Vault Key.
    curve string
    The EC Curve name of this Key Vault Key.
    e string
    The RSA public exponent of this Key Vault Key.
    id string
    The provider-assigned unique ID for this managed resource.
    keyOpts string[]
    A list of JSON web key operations assigned to this Key Vault Key
    keySize number
    Specifies the Size of this Key Vault Key.
    keyType string
    Specifies the Key Type of this Key Vault Key
    keyVaultId string
    n string
    The RSA modulus of this Key Vault Key.
    name string
    publicKeyOpenssh string
    The OpenSSH encoded public key of this Key Vault Key.
    publicKeyPem string
    The PEM encoded public key of this Key Vault Key.
    tags {[key: string]: string}
    A mapping of tags assigned to this Key Vault Key.
    version string
    The current version of the Key Vault Key.
    versionlessId string
    The Base ID of the Key Vault Key.
    x string
    The EC X component of this Key Vault Key.
    y string
    The EC Y component of this Key Vault Key.
    curve str
    The EC Curve name of this Key Vault Key.
    e str
    The RSA public exponent of this Key Vault Key.
    id str
    The provider-assigned unique ID for this managed resource.
    key_opts Sequence[str]
    A list of JSON web key operations assigned to this Key Vault Key
    key_size int
    Specifies the Size of this Key Vault Key.
    key_type str
    Specifies the Key Type of this Key Vault Key
    key_vault_id str
    n str
    The RSA modulus of this Key Vault Key.
    name str
    public_key_openssh str
    The OpenSSH encoded public key of this Key Vault Key.
    public_key_pem str
    The PEM encoded public key of this Key Vault Key.
    tags Mapping[str, str]
    A mapping of tags assigned to this Key Vault Key.
    version str
    The current version of the Key Vault Key.
    versionless_id str
    The Base ID of the Key Vault Key.
    x str
    The EC X component of this Key Vault Key.
    y str
    The EC Y component of this Key Vault Key.
    curve String
    The EC Curve name of this Key Vault Key.
    e String
    The RSA public exponent of this Key Vault Key.
    id String
    The provider-assigned unique ID for this managed resource.
    keyOpts List<String>
    A list of JSON web key operations assigned to this Key Vault Key
    keySize Number
    Specifies the Size of this Key Vault Key.
    keyType String
    Specifies the Key Type of this Key Vault Key
    keyVaultId String
    n String
    The RSA modulus of this Key Vault Key.
    name String
    publicKeyOpenssh String
    The OpenSSH encoded public key of this Key Vault Key.
    publicKeyPem String
    The PEM encoded public key of this Key Vault Key.
    tags Map<String>
    A mapping of tags assigned to this Key Vault Key.
    version String
    The current version of the Key Vault Key.
    versionlessId String
    The Base ID of the Key Vault Key.
    x String
    The EC X component of this Key Vault Key.
    y String
    The EC Y component of this Key Vault Key.

    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.