@azure/keyvault-admin package

クラス

KeyVaultAccessControlClient	KeyVaultAccessControlClient には、特定の Azure Key Vault インスタンスのアクセス制御とロールの割り当てを管理するメソッドが用意されています。 クライアントは、ロールの作成、取得、および削除をサポートしています。
KeyVaultBackupClient	KeyVaultBackupClient には、特定の Azure Key Vault インスタンスのバックアップを生成し、バックアップを復元する方法が用意されています。 このクライアントは、完全バックアップの生成、特定のキーの選択的復元、Key Vault インスタンスの完全復元をサポートします。
KeyVaultSettingsClient	KeyVaultSettingsClient には、Azure Key Vault の設定を作成、更新、取得、および一覧表示するための非同期メソッドが用意されています。

インターフェイス

AccessControlClientOptions	Key Vault の AccessControlClient で受け入れられる省略可能なパラメーター
BooleanKeyVaultSetting	ブール型の Key Vault 設定。 指定された KeyVaultSetting がブール値であるかどうかを確認するには、isBooleanSetting 使用します。
CreateRoleAssignmentOptions	createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
DeleteRoleAssignmentOptions	deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
DeleteRoleDefinitionOptions	deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)に渡される省略可能なパラメーターを表すインターフェイス。
GetRoleAssignmentOptions	getRoleAssignment(string, string, GetRoleAssignmentOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
GetRoleDefinitionOptions	getRoleDefinition(string, string, GetRoleDefinitionOptions)に渡される省略可能なパラメーターを表すインターフェイス。
GetSettingOptions	getSetting に渡すことができる省略可能なパラメーター 表すインターフェイス
KeyVaultAdminPollOperationState	Key Vault Admin Poller の操作の状態を表すインターフェイス。
KeyVaultBackupClientOptions	KeyVaultBackupClient で受け入れられる省略可能なパラメーター
KeyVaultBackupPollerOptions	beginBackup(string, string, KeyVaultBeginBackupOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
KeyVaultBackupResult	バックアップ操作の結果を表すインターフェイス。
KeyVaultBeginBackupOptions	beginBackup(string, string, KeyVaultBeginBackupOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
KeyVaultBeginRestoreOptions	beginRestore(string, string, KeyVaultBeginRestoreOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
KeyVaultBeginSelectiveKeyRestoreOptions	beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
KeyVaultPermission	Key Vault のアクセス許可の一覧。
KeyVaultRestoreOperationState	Key Vault の復元ポーリング操作の状態のパブリックに利用可能なプロパティを表すインターフェイス。
KeyVaultRestoreResult	復元操作の結果を表すインターフェイス。
KeyVaultRoleAssignment	Key Vault ロールの割り当て。
KeyVaultRoleAssignmentProperties	ロールの割り当てプロパティ。
KeyVaultRoleDefinition	Key Vault ロールの定義。
KeyVaultSelectiveKeyRestoreOperationState	Key Vault の復元ポーリング操作の状態のパブリックに利用可能なプロパティを表すインターフェイス。
KeyVaultSelectiveKeyRestoreResult	選択的キー復元操作の結果を表すインターフェイス。
KeyVaultSetting	Key Vault の設定。
ListRoleAssignmentsOptions	listRoleAssignments(string, ListRoleAssignmentsOptions)に渡される省略可能なパラメーターを表すインターフェイス。
ListRoleAssignmentsPageSettings	検索結果の次のページを取得するための引数。
ListRoleDefinitionsOptions	listRoleDefinitions(string, ListRoleDefinitionsOptions)に渡される省略可能なパラメーターを表すインターフェイス。
ListRoleDefinitionsPageSettings	検索結果の次のページを取得するための引数。
ListSettingsOptions	<xref:KeyVaultSettingsClient.listSettings> に渡すことができる省略可能なパラメーターを表すインターフェイス
ListSettingsResponse	<xref:KeyVaultSettingsClient.listSettings> によって返される応答を表すインターフェイス
SetRoleDefinitionOptions	setRoleDefinition(string, SetRoleDefinitionOptions)に渡される省略可能なパラメーターを表すインターフェイス。
SettingsClientOptions	KeyVaultSettingsClient で受け入れられる省略可能なパラメーター。
UpdateSettingOptions	updateSetting に渡すことができる省略可能なパラメーター 表すインターフェイス

型エイリアス

KeyVaultBackupOperationState	バックアップ Key Vault のポーリング操作の状態のパブリックに利用可能なプロパティを表すインターフェイス。
KeyVaultDataAction	DataAction の値を定義します。 DataAction と同じ意味で使用できる <xref:KnownDataAction>、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Microsoft.KeyVault/managedHsm/keys/read/action: HSM キー メタデータを読み取ります。 Microsoft.KeyVault/managedHsm/keys/write/action: HSM キーを更新します。 Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: 削除された HSM キーを読み取ります。 Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: 削除された HSM キーを回復します。 Microsoft.KeyVault/managedHsm/keys/backup/action: HSM キーをバックアップします。 Microsoft.KeyVault/managedHsm/keys/restore/action: HSM キーを復元します。 Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: ロールの割り当てを削除します。 Microsoft.KeyVault/managedHsm/roleAssignments/read/action: ロールの割り当てを取得します。 Microsoft.KeyVault/managedHsm/roleAssignments/write/action: ロールの割り当てを作成または更新します。 Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: ロール定義を取得します。 Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: ロール定義を作成または更新します。 Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: ロール定義を削除します。 Microsoft.KeyVault/managedHsm/keys/encrypt/action: HSM キーを使用して暗号化します。 Microsoft.KeyVault/managedHsm/keys/decrypt/action: HSM キーを使用して復号化します。 Microsoft.KeyVault/managedHsm/keys/wrap/action: HSM キーを使用してラップします。 Microsoft.KeyVault/managedHsm/keys/unwrap/action: HSM キーを使用してラップを解除します。 Microsoft.KeyVault/managedHsm/keys/sign/action: HSM キーを使用して署名します。 Microsoft.KeyVault/managedHsm/keys/verify/action: HSM キーを使用して検証します。 Microsoft.KeyVault/managedHsm/keys/create: HSM キーを作成します。 Microsoft.KeyVault/managedHsm/keys/delete: HSM キーを削除します。 Microsoft.KeyVault/managedHsm/keys/export/action: HSM キーをエクスポートします。 Microsoft.KeyVault/managedHsm/keys/release/action: Secure Key Release を使用して HSM キーを解放します。 Microsoft.KeyVault/managedHsm/keys/import/action: HSM キーをインポートします。 Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: 削除された HSM キーを消去します。 Microsoft.KeyVault/managedHsm/securitydomain/download/action: HSM セキュリティ ドメインをダウンロードします。 Microsoft.KeyVault/managedHsm/securitydomain/download/read: HSM セキュリティ ドメインのダウンロードの状態を確認します。 Microsoft.KeyVault/managedHsm/securitydomain/upload/action: HSM セキュリティ ドメインをアップロードします。 Microsoft.KeyVault/managedHsm/securitydomain/upload/read: HSM セキュリティ ドメイン交換ファイルの状態を確認します。 Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: HSM セキュリティ ドメイン転送キーをダウンロードします。 Microsoft.KeyVault/managedHsm/backup/start/action: HSM バックアップを開始します。 Microsoft.KeyVault/managedHsm/restore/start/action: HSM の復元を開始します。 Microsoft.KeyVault/managedHsm/backup/status/action: HSM バックアップの状態を読み取ります。 Microsoft.KeyVault/managedHsm/restore/status/action: HSM の復元状態を読み取ります。 Microsoft.KeyVault/managedHsm/rng/action: 乱数を生成します。
KeyVaultRoleScope	RoleScope の値を定義します。 RoleScope と同じ意味で使用できる <xref:KnownRoleScope>、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 /: グローバル スコープ /keys: キー スコープ
SUPPORTED_API_VERSIONS	サポートされている API バージョン

列挙型

KnownKeyVaultDataAction	サービスが受け入れる KeyVaultDataAction の既知の値。
KnownKeyVaultRoleScope	サービスが受け入れる KeyVaultRoleScope の既知の値。

関数

isBooleanSetting(KeyVaultSetting)

指定された KeyVaultSetting が BooleanKeyVaultSetting (つまり、ブール値を持つ) かどうかを判断します。

関数の詳細

isBooleanSetting(KeyVaultSetting)

指定された KeyVaultSetting が BooleanKeyVaultSetting (つまり、ブール値を持つ) かどうかを判断します。

function isBooleanSetting(setting: KeyVaultSetting): setting

パラメーター

setting

KeyVaultSetting

戻り値

setting