CreateKeyOptions interface
An interface representing the optional parameters that can be passed to createKey(string, string, CreateKeyOptions)
- Extends
Properties
curve | Elliptic curve name. For valid values, see KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K' |
enabled | Determines whether the object is enabled. |
expires |
Expiry date in UTC. |
exportable | Indicates whether the private key can be exported. |
hsm | Whether to import as a hardware key (HSM) or software key. |
key |
Json web key operations. For more information on possible key operations, see KeyOperation. |
key |
The key size in bits. For example: 2048, 3072, or 4096 for RSA. |
not |
Not before date in UTC. |
release |
A KeyReleasePolicy object specifying the rules under which the key can be exported. |
tags | Application specific metadata in the form of key-value pairs. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
request |
Options used when creating and sending HTTP requests for this operation. |
serializer |
Options to override serialization/de-serialization behavior. |
tracing |
Options used when tracing is enabled. |
Property Details
curve
Elliptic curve name. For valid values, see KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'
curve?: string
Property Value
string
enabled
Determines whether the object is enabled.
enabled?: boolean
Property Value
boolean
expiresOn
Expiry date in UTC.
expiresOn?: Date
Property Value
Date
exportable
Indicates whether the private key can be exported.
exportable?: boolean
Property Value
boolean
hsm
Whether to import as a hardware key (HSM) or software key.
hsm?: boolean
Property Value
boolean
keyOps
Json web key operations. For more information on possible key operations, see KeyOperation.
keyOps?: string[]
Property Value
string[]
keySize
The key size in bits. For example: 2048, 3072, or 4096 for RSA.
keySize?: number
Property Value
number
notBefore
Not before date in UTC.
notBefore?: Date
Property Value
Date
releasePolicy
A KeyReleasePolicy object specifying the rules under which the key can be exported.
releasePolicy?: KeyReleasePolicy
Property Value
tags
Application specific metadata in the form of key-value pairs.
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From coreClient.OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallback
Property Value
Inherited From coreClient.OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From coreClient.OperationOptions.requestOptions
serializerOptions
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptions
Property Value
Inherited From coreClient.OperationOptions.serializerOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From coreClient.OperationOptions.tracingOptions