@azure/keyvault-admin package

クラス

KeyVaultAccessControlClient

KeyVaultAccessControlClient には、特定の Azure Key Vault インスタンスでのアクセス制御とロールの割り当てを管理するメソッドが用意されています。 クライアントでは、ロールの作成、取得、および削除がサポートされています。

KeyVaultBackupClient

KeyVaultBackupClient には、特定の Azure Key Vault インスタンスのバックアップを生成し、バックアップを復元する方法が用意されています。 このクライアントでは、完全バックアップの生成、特定のキーの選択的復元、Key Vault インスタンスの完全復元がサポートされています。

インターフェイス

AccessControlClientOptions

Key Vaultの AccessControlClient で受け入れられる省略可能なパラメーター

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)表すインターフェイス。

KeyVaultAdminPollOperationState

Key Vault 管理 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

選択的キー復元操作の結果を表すインターフェイス。

ListRoleAssignmentsOptions

に渡される省略可能なパラメーターを listRoleAssignments(string, ListRoleAssignmentsOptions)表すインターフェイス。

ListRoleAssignmentsPageSettings

検索結果の次のページを取得するための引数。

ListRoleDefinitionsOptions

に渡される省略可能なパラメーターを listRoleDefinitions(string, ListRoleDefinitionsOptions)表すインターフェイス。

ListRoleDefinitionsPageSettings

検索結果の次のページを取得するための引数。

SetRoleDefinitionOptions

に渡される省略可能なパラメーターを setRoleDefinition(string, SetRoleDefinitionOptions)表すインターフェイス。

型エイリアス

KeyVaultBackupOperationState

バックアップ Key Vaultのポーリング操作の状態の一般公開されているプロパティを表すインターフェイス。

KeyVaultDataAction

DataAction の値を定義します。
<xref:KnownDataAction> DataAction と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

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 の値を定義します。
<xref:KnownRoleScope> は RoleScope と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

/: グローバル スコープ
/keys: キースコープ

SUPPORTED_API_VERSIONS

サポートされる API バージョン

列挙型

KnownKeyVaultDataAction

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

KnownKeyVaultRoleScope

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