CreateRsaKeyOptions interface

Package:

@azure/keyvault-keys

An interface representing the optional parameters that can be passed to createRsaKey(string, CreateRsaKeyOptions)

Extends

CreateKeyOptions

Properties

publicExponent

The public exponent for a RSA key.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
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.
expiresOn	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.
keyOps	Json web key operations. For more information on possible key operations, see KeyOperation.
keySize	The key size in bits. For example: 2048, 3072, or 4096 for RSA.
notBefore	Not before date in UTC.
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.
releasePolicy	A KeyReleasePolicy object specifying the rules under which the key can be exported.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tags	Application specific metadata in the form of key-value pairs.
tracingOptions	Options used when tracing is enabled.

Property Details

publicExponent

The public exponent for a RSA key.

publicExponent?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From CreateKeyOptions.abortSignal

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

Inherited From CreateKeyOptions.curve

enabled

Determines whether the object is enabled.

enabled?: boolean

Property Value

boolean

Inherited From CreateKeyOptions.enabled

expiresOn

Expiry date in UTC.

expiresOn?: Date

Property Value

Date

Inherited From CreateKeyOptions.expiresOn

exportable

Indicates whether the private key can be exported.

exportable?: boolean

Property Value

boolean

Inherited From CreateKeyOptions.exportable

hsm

Whether to import as a hardware key (HSM) or software key.

hsm?: boolean

Property Value

boolean

Inherited From CreateKeyOptions.hsm

keyOps

Json web key operations. For more information on possible key operations, see KeyOperation.

keyOps?: string[]

Property Value

string[]

Inherited From CreateKeyOptions.keyOps

keySize

The key size in bits. For example: 2048, 3072, or 4096 for RSA.

keySize?: number

Property Value

number

Inherited From CreateKeyOptions.keySize

notBefore

Not before date in UTC.

notBefore?: Date

Property Value

Date

Inherited From CreateKeyOptions.notBefore

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

RawResponseCallback

Inherited From CreateKeyOptions.onResponse

releasePolicy

A KeyReleasePolicy object specifying the rules under which the key can be exported.

releasePolicy?: KeyReleasePolicy

Property Value

KeyReleasePolicy

Inherited From CreateKeyOptions.releasePolicy

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From CreateKeyOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From CreateKeyOptions.serializerOptions

tags

Application specific metadata in the form of key-value pairs.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From CreateKeyOptions.tags

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CreateKeyOptions.tracingOptions