다음을 통해 공유


@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 관리자 Poller 작업의 상태를 나타내는 인터페이스입니다.

KeyVaultBackupClientOptions

KeyVaultBackupClient에서 허용하는 선택적 매개 변수

KeyVaultBackupPollerOptions

beginBackup(string, string, KeyVaultBeginBackupOptions) 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

KeyVaultBackupResult

백업 작업의 결과를 나타내는 인터페이스입니다.

KeyVaultBeginBackupOptions

beginBackup 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

KeyVaultBeginPreBackupOptions

beginPreBackup 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

KeyVaultBeginPreRestoreOptions

beginPreRestore 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

KeyVaultBeginRestoreOptions

beginRestore 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

KeyVaultBeginSelectiveKeyRestoreOptions

beginSelectiveKeyRestore 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

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> 반환된 응답을 나타내는 인터페이스입니다.

PollerLike

장기 실행 작업을 폴링하는 데 사용할 수 있는 간단한 폴러입니다.

SetRoleDefinitionOptions

setRoleDefinition(string, SetRoleDefinitionOptions)전달된 선택적 매개 변수를 나타내는 인터페이스입니다.

SettingsClientOptions

KeyVaultSettingsClient에서 허용하는 선택적 매개 변수입니다.

UpdateSettingOptions

updateSetting 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다.

형식 별칭

KeyVaultBackupOperationState

백업 Key Vault의 폴링 작업 상태의 공개적으로 사용할 수 있는 속성을 나타내는 인터페이스입니다.

KeyVaultDataAction

데이터 작업에 대해 지원되는 권한입니다.
<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: Backup 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 : 보안 키 릴리스를 사용하여 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/다운로드/읽기: HSM 보안 도메인 다운로드의 상태를 확인합니다.
microsoft.KeyVault/managedHsm/securitydomain/upload/action : HSM 보안 도메인 업로드
microsoft.KeyVault/managedHsm/securitydomain/upload/read : HSM 보안 도메인 교환 파일의 상태를 확인합니다.
microsoft.KeyVault/managedHsm/securitydomain/transferkey/읽기 : 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> 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

서비스에서 지원하는 알려진 값

/: 전역 범위
/keys: 키 범위

OperationStatus

장기 실행 작업의 상태입니다.
<xref:KnownOperationStatus> OperationStatus와 상호 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

서비스에서 지원하는 알려진 값

InProgress: 작업이 진행 중입니다.
성공: 작업이 성공적으로 완료되었습니다.
취소된: 작업이 취소되었습니다.
실패한: 작업이 실패했습니다.

SUPPORTED_API_VERSIONS

지원되는 API 버전

열거형

KnownKeyVaultDataAction

데이터 작업에 대해 지원되는 권한입니다.

KnownKeyVaultRoleScope

역할 범위입니다.

함수

isBooleanSetting(KeyVaultSetting)

지정된 KeyVaultSetting 부울 값이 BooleanKeyVaultSetting있는지 여부를 확인합니다.

변수

LATEST_API_VERSION

최신 지원 키 볼트 서비스 API 버전입니다.

SDK_VERSION

현재 버전의 Key Vault Admin SDK입니다.

함수 세부 정보

isBooleanSetting(KeyVaultSetting)

지정된 KeyVaultSetting 부울 값이 BooleanKeyVaultSetting있는지 여부를 확인합니다.

function isBooleanSetting(setting: KeyVaultSetting): setting

매개 변수

setting
KeyVaultSetting

반환

setting

Variable Details

LATEST_API_VERSION

최신 지원 키 볼트 서비스 API 버전입니다.

LATEST_API_VERSION: "7.6"

형식

"7.6"

SDK_VERSION

현재 버전의 Key Vault Admin SDK입니다.

SDK_VERSION: string

형식

string