KeyProperties interface

パッケージ:

@azure/keyvault-keys

KeyVaultKey のプロパティを表すインターフェイス

プロパティ

createdOn	UTC での作成時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
enabled	オブジェクトが有効かどうかを判断します。
expiresOn	UTC の有効期限。
exportable	秘密キーをエクスポートできるかどうかを示します。
hsmPlatform	基になる HSM プラットフォーム。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
id	キー識別子。
managed	True を指定すると、シークレットの有効期間がキー コンテナーによって管理されます。 これが証明書をバックアップするシークレットの場合、マネージドは true になります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name	キーの名前です。
notBefore	UTC の日付より前ではありません。
recoverableDays	softDelete データの保持日。 softDelete が有効になっている >=7 場合、値は と <=90 にする必要があります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
recoveryLevel	現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合は、保持間隔の最後にキーを消去できるのはシステムだけです。 使用可能な値には、'Purgeable'、'Recoverable+Purgeable'、'Recoverable'、'Recoverable+ProtectedSubscription' が含まれます。 注: このプロパティはシリアル化されません。サーバーによってのみ設定できます。
releasePolicy	キーをエクスポートできる規則を指定する KeyReleasePolicy オブジェクト。
tags	キーと値のペアの形式による、アプリケーション固有のメタデータ。
updatedOn	UTC の最終更新時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
vaultUrl	コンテナー URI。
version	キーのバージョン。 未定義の場合があります。

プロパティの詳細

createdOn

UTC での作成時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

createdOn?: Date

プロパティ値

Date

enabled

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

enabled?: boolean

プロパティ値

boolean

expiresOn

UTC の有効期限。

expiresOn?: Date

プロパティ値

Date

exportable

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

exportable?: boolean

プロパティ値

boolean

hsmPlatform

基になる HSM プラットフォーム。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

hsmPlatform?: string

プロパティ値

string

id

キー識別子。

id?: string

プロパティ値

string

managed

True を指定すると、シークレットの有効期間がキー コンテナーによって管理されます。 これが証明書をバックアップするシークレットの場合、マネージドは true になります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

managed?: boolean

プロパティ値

boolean

name

キーの名前です。

name: string

プロパティ値

string

notBefore

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

notBefore?: Date

プロパティ値

Date

recoverableDays

softDelete データの保持日。 softDelete が有効になっている >=7 場合、値は と <=90 にする必要があります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

recoverableDays?: number

プロパティ値

number

recoveryLevel

現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合は、保持間隔の最後にキーを消去できるのはシステムだけです。 使用可能な値には、'Purgeable'、'Recoverable+Purgeable'、'Recoverable'、'Recoverable+ProtectedSubscription' が含まれます。 注: このプロパティはシリアル化されません。サーバーによってのみ設定できます。

recoveryLevel?: string

プロパティ値

string

releasePolicy

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

releasePolicy?: KeyReleasePolicy

プロパティ値

KeyReleasePolicy

tags

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

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

プロパティ値

{[propertyName: string]: string}

updatedOn

UTC の最終更新時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

updatedOn?: Date

プロパティ値

Date

vaultUrl

コンテナー URI。

vaultUrl: string

プロパティ値

string

version

キーのバージョン。 未定義の場合があります。

version?: string

プロパティ値

string