Language

CreateAkpKeyOptions Class

Definition

The properties needed to create an Algorithm Key Pair (AKP) key, such as ML-DSA, using the KeyClient.

public class CreateAkpKeyOptions : Azure.Security.KeyVault.Keys.CreateKeyOptions
type CreateAkpKeyOptions = class
    inherit CreateKeyOptions
Public Class CreateAkpKeyOptions
Inherits CreateKeyOptions
Inheritance
CreateAkpKeyOptions

Constructors

Name Description
CreateAkpKeyOptions(String, AkpAlgorithm, Boolean)

Initializes a new instance of the CreateAkpKeyOptions class.

Properties

Name Description
Algorithm

Gets the algorithm identifier for the Algorithm Key Pair (AKP) key. See AkpAlgorithm for possible values.

Enabled

Gets or sets a value indicating whether the key will be enabled. If null, the service default is used.

(Inherited from CreateKeyOptions)
ExpiresOn

Gets or sets a DateTimeOffset indicating when the key will expire.

(Inherited from CreateKeyOptions)
Exportable

Gets or sets a value indicating whether the private key can be exported.

(Inherited from CreateKeyOptions)
HardwareProtected

Gets a value indicating whether to create a hardware-protected key in a hardware security module (HSM).

KeyOperations

Gets a list of KeyOperation values the key should support.

(Inherited from CreateKeyOptions)
KeyType

Gets the key type of the JsonWebKey to create, including Akp and AkpHsm.

Name

Gets the name of the key to create.

NotBefore

Gets or sets a DateTimeOffset indicating when the key will be valid.

(Inherited from CreateKeyOptions)
ReleasePolicy

Gets or sets the policy rules under which the key can be exported.

(Inherited from CreateKeyOptions)
Tags

Gets a dictionary of tags with specific metadata about the key. Although this collection cannot be set, it can be modified or initialized with a collection initializer.

(Inherited from CreateKeyOptions)

Applies to