Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. keyvault
  5. getKey
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.keyvault.getKey

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets the current version of the specified key from the specified key vault. API Version: 2019-09-01.

    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_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            vault_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_name: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            vault_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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:keyvault:getKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KeyName string
    The name of the key to be retrieved.
    ResourceGroupName string
    The name of the resource group which contains the specified key vault.
    VaultName string
    The name of the vault which contains the key to be retrieved.
    KeyName string
    The name of the key to be retrieved.
    ResourceGroupName string
    The name of the resource group which contains the specified key vault.
    VaultName string
    The name of the vault which contains the key to be retrieved.
    keyName String
    The name of the key to be retrieved.
    resourceGroupName String
    The name of the resource group which contains the specified key vault.
    vaultName String
    The name of the vault which contains the key to be retrieved.
    keyName string
    The name of the key to be retrieved.
    resourceGroupName string
    The name of the resource group which contains the specified key vault.
    vaultName string
    The name of the vault which contains the key to be retrieved.
    key_name str
    The name of the key to be retrieved.
    resource_group_name str
    The name of the resource group which contains the specified key vault.
    vault_name str
    The name of the vault which contains the key to be retrieved.
    keyName String
    The name of the key to be retrieved.
    resourceGroupName String
    The name of the resource group which contains the specified key vault.
    vaultName String
    The name of the vault which contains the key to be retrieved.

    getKey Result

    The following output properties are available:

    Id string
    Fully qualified identifier of the key vault resource.
    KeyUri string
    The URI to retrieve the current version of the key.
    KeyUriWithVersion string
    The URI to retrieve the specific version of the key.
    Location string
    Azure location of the key vault resource.
    Name string
    Name of the key vault resource.
    Tags Dictionary<string, string>
    Tags assigned to the key vault resource.
    Type string
    Resource type of the key vault resource.
    Attributes Pulumi.AzureNative.KeyVault.Outputs.KeyAttributesResponse
    The attributes of the key.
    CurveName string
    The elliptic curve name. For valid values, see JsonWebKeyCurveName.
    KeyOps List<string>
    KeySize int
    The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    Kty string
    The type of the key. For valid values, see JsonWebKeyType.
    Id string
    Fully qualified identifier of the key vault resource.
    KeyUri string
    The URI to retrieve the current version of the key.
    KeyUriWithVersion string
    The URI to retrieve the specific version of the key.
    Location string
    Azure location of the key vault resource.
    Name string
    Name of the key vault resource.
    Tags map[string]string
    Tags assigned to the key vault resource.
    Type string
    Resource type of the key vault resource.
    Attributes KeyAttributesResponse
    The attributes of the key.
    CurveName string
    The elliptic curve name. For valid values, see JsonWebKeyCurveName.
    KeyOps []string
    KeySize int
    The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    Kty string
    The type of the key. For valid values, see JsonWebKeyType.
    id String
    Fully qualified identifier of the key vault resource.
    keyUri String
    The URI to retrieve the current version of the key.
    keyUriWithVersion String
    The URI to retrieve the specific version of the key.
    location String
    Azure location of the key vault resource.
    name String
    Name of the key vault resource.
    tags Map<String,String>
    Tags assigned to the key vault resource.
    type String
    Resource type of the key vault resource.
    attributes KeyAttributesResponse
    The attributes of the key.
    curveName String
    The elliptic curve name. For valid values, see JsonWebKeyCurveName.
    keyOps List<String>
    keySize Integer
    The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    kty String
    The type of the key. For valid values, see JsonWebKeyType.
    id string
    Fully qualified identifier of the key vault resource.
    keyUri string
    The URI to retrieve the current version of the key.
    keyUriWithVersion string
    The URI to retrieve the specific version of the key.
    location string
    Azure location of the key vault resource.
    name string
    Name of the key vault resource.
    tags {[key: string]: string}
    Tags assigned to the key vault resource.
    type string
    Resource type of the key vault resource.
    attributes KeyAttributesResponse
    The attributes of the key.
    curveName string
    The elliptic curve name. For valid values, see JsonWebKeyCurveName.
    keyOps string[]
    keySize number
    The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    kty string
    The type of the key. For valid values, see JsonWebKeyType.
    id str
    Fully qualified identifier of the key vault resource.
    key_uri str
    The URI to retrieve the current version of the key.
    key_uri_with_version str
    The URI to retrieve the specific version of the key.
    location str
    Azure location of the key vault resource.
    name str
    Name of the key vault resource.
    tags Mapping[str, str]
    Tags assigned to the key vault resource.
    type str
    Resource type of the key vault resource.
    attributes KeyAttributesResponse
    The attributes of the key.
    curve_name str
    The elliptic curve name. For valid values, see JsonWebKeyCurveName.
    key_ops Sequence[str]
    key_size int
    The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    kty str
    The type of the key. For valid values, see JsonWebKeyType.
    id String
    Fully qualified identifier of the key vault resource.
    keyUri String
    The URI to retrieve the current version of the key.
    keyUriWithVersion String
    The URI to retrieve the specific version of the key.
    location String
    Azure location of the key vault resource.
    name String
    Name of the key vault resource.
    tags Map<String>
    Tags assigned to the key vault resource.
    type String
    Resource type of the key vault resource.
    attributes Property Map
    The attributes of the key.
    curveName String
    The elliptic curve name. For valid values, see JsonWebKeyCurveName.
    keyOps List<String>
    keySize Number
    The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    kty String
    The type of the key. For valid values, see JsonWebKeyType.

    Supporting Types

    KeyAttributesResponse

    Created double
    Creation time in seconds since 1970-01-01T00:00:00Z.
    RecoveryLevel string
    The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
    Updated double
    Last updated time in seconds since 1970-01-01T00:00:00Z.
    Enabled bool
    Determines whether or not the object is enabled.
    Expires double
    Expiry date in seconds since 1970-01-01T00:00:00Z.
    NotBefore double
    Not before date in seconds since 1970-01-01T00:00:00Z.
    Created float64
    Creation time in seconds since 1970-01-01T00:00:00Z.
    RecoveryLevel string
    The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
    Updated float64
    Last updated time in seconds since 1970-01-01T00:00:00Z.
    Enabled bool
    Determines whether or not the object is enabled.
    Expires float64
    Expiry date in seconds since 1970-01-01T00:00:00Z.
    NotBefore float64
    Not before date in seconds since 1970-01-01T00:00:00Z.
    created Double
    Creation time in seconds since 1970-01-01T00:00:00Z.
    recoveryLevel String
    The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
    updated Double
    Last updated time in seconds since 1970-01-01T00:00:00Z.
    enabled Boolean
    Determines whether or not the object is enabled.
    expires Double
    Expiry date in seconds since 1970-01-01T00:00:00Z.
    notBefore Double
    Not before date in seconds since 1970-01-01T00:00:00Z.
    created number
    Creation time in seconds since 1970-01-01T00:00:00Z.
    recoveryLevel string
    The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
    updated number
    Last updated time in seconds since 1970-01-01T00:00:00Z.
    enabled boolean
    Determines whether or not the object is enabled.
    expires number
    Expiry date in seconds since 1970-01-01T00:00:00Z.
    notBefore number
    Not before date in seconds since 1970-01-01T00:00:00Z.
    created float
    Creation time in seconds since 1970-01-01T00:00:00Z.
    recovery_level str
    The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
    updated float
    Last updated time in seconds since 1970-01-01T00:00:00Z.
    enabled bool
    Determines whether or not the object is enabled.
    expires float
    Expiry date in seconds since 1970-01-01T00:00:00Z.
    not_before float
    Not before date in seconds since 1970-01-01T00:00:00Z.
    created Number
    Creation time in seconds since 1970-01-01T00:00:00Z.
    recoveryLevel String
    The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
    updated Number
    Last updated time in seconds since 1970-01-01T00:00:00Z.
    enabled Boolean
    Determines whether or not the object is enabled.
    expires Number
    Expiry date in seconds since 1970-01-01T00:00:00Z.
    notBefore Number
    Not before date in seconds since 1970-01-01T00:00:00Z.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native