Class Key

Manages a Key Vault Key.

Inheritance

System.Object

Resource

CustomResource

Key

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.KeyVault

Assembly: Pulumi.Azure.dll

Syntax

public class Key : CustomResource

Constructors

Key(String, KeyArgs, CustomResourceOptions)

Create a Key resource with the given unique name, arguments, and options.

Declaration

public Key(string name, KeyArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
KeyArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Curve

Specifies the curve to use when creating an EC key. Possible values are P-256, P-384, P-521, and SECP256K1. This field will be required in a future release if key_type is EC or EC-HSM. The API will default to P-256 if nothing is specified. Changing this forces a new resource to be created.

Declaration

public Output<string> Curve { get; }

Property Value

Type	Description
Output<System.String>

E

The RSA public exponent of this Key Vault Key.

Declaration

public Output<string> E { get; }

Property Value

Type	Description
Output<System.String>

ExpirationDate

Expiration UTC datetime (Y-m-d'T'H:M:S'Z').

Declaration

public Output<string> ExpirationDate { get; }

Property Value

Type	Description
Output<System.String>

KeyOpts

A list of JSON web key operations. Possible values include: decrypt, encrypt, sign, unwrapKey, verify and wrapKey. Please note these values are case sensitive.

Declaration

public Output<ImmutableArray<string>> KeyOpts { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

KeySize

Specifies the Size of the RSA key to create in bytes. For example, 1024 or 2048. Note: This field is required if key_type is RSA or RSA-HSM. Changing this forces a new resource to be created.

Declaration

public Output<int?> KeySize { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

KeyType

Specifies the Key Type to use for this Key Vault Key. Possible values are EC (Elliptic Curve), EC-HSM, Oct (Octet), RSA and RSA-HSM. Changing this forces a new resource to be created.

Declaration

public Output<string> KeyType { get; }

Property Value

Type	Description
Output<System.String>

KeyVaultId

The ID of the Key Vault where the Key should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> KeyVaultId { get; }

Property Value

Type	Description
Output<System.String>

N

The RSA modulus of this Key Vault Key.

Declaration

public Output<string> N { get; }

Property Value

Type	Description
Output<System.String>

Name

Specifies the name of the Key Vault Key. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NotBeforeDate

Key not usable before the provided UTC datetime (Y-m-d'T'H:M:S'Z').

Declaration

public Output<string> NotBeforeDate { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Version

The current version of the Key Vault Key.

Declaration

public Output<string> Version { get; }

Property Value

Type	Description
Output<System.String>

X

The EC X component of this Key Vault Key.

Declaration

public Output<string> X { get; }

Property Value

Type	Description
Output<System.String>

Y

The EC Y component of this Key Vault Key.

Declaration

public Output<string> Y { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, KeyState, CustomResourceOptions)

Get an existing Key resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Key Get(string name, Input<string> id, KeyState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
KeyState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Key