CreateKeyOptions interface

パッケージ:

@azure/keyvault-keys

渡すことができる省略可能なパラメーターを表すインターフェイス createKey(string, string, CreateKeyOptions)

Extends

OperationOptions

プロパティ

curve	楕円曲線名。 有効な値については、「KeyCurveName」を参照してください。 使用できる値は、'P-256'、'P-384'、'P-521'、'P-256K' です。
enabled	オブジェクトが有効かどうかを判断します。
expiresOn	UTC の有効期限。
exportable	秘密キーをエクスポートできるかどうかを示します。
hsm	ハードウェア キー (HSM) またはソフトウェア キーとしてインポートするかどうか。
keyOps	Json Web キー操作。 考えられるキー操作の詳細については、「KeyOperation」を参照してください。
keySize	キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。
notBefore	UTC の日付より前ではありません。
releasePolicy	キーをエクスポートできる規則を指定する KeyReleasePolicy オブジェクト。
tags	キーと値のペアの形式による、アプリケーション固有のメタデータ。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
serializerOptions	シリアル化/シリアル化解除の動作をオーバーライドするオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

curve

楕円曲線名。 有効な値については、「KeyCurveName」を参照してください。 使用できる値は、'P-256'、'P-384'、'P-521'、'P-256K' です。

curve?: string

プロパティ値

string

enabled

オブジェクトが有効かどうかを判断します。

enabled?: boolean

プロパティ値

boolean

expiresOn

UTC の有効期限。

expiresOn?: Date

プロパティ値

Date

exportable

秘密キーをエクスポートできるかどうかを示します。

exportable?: boolean

プロパティ値

boolean

hsm

ハードウェア キー (HSM) またはソフトウェア キーとしてインポートするかどうか。

hsm?: boolean

プロパティ値

boolean

keyOps

Json Web キー操作。 考えられるキー操作の詳細については、「KeyOperation」を参照してください。

keyOps?: string[]

プロパティ値

string[]

keySize

キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。

keySize?: number

プロパティ値

number

notBefore

UTC の日付より前ではありません。

notBefore?: Date

プロパティ値

Date

releasePolicy

キーをエクスポートできる規則を指定する KeyReleasePolicy オブジェクト。

releasePolicy?: KeyReleasePolicy

プロパティ値

KeyReleasePolicy

tags

キーと値のペアの形式による、アプリケーション固有のメタデータ。

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

プロパティ値

{[propertyName: string]: string}

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

coreClient.OperationOptions.abortSignal から継承

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

coreClient.OperationOptions.onResponse から継承

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

coreClient.OperationOptions.requestOptions から継承

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

coreClient.OperationOptions.serializerOptions から継承

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

coreClient.OperationOptions.tracingOptions から継承