@azure/keyvault-keys package
클래스
| CryptographyClient |
Azure Key Vault 키 또는 로컬 <xref:JsonWebKey>암호화 작업을 수행하는 데 사용되는 클라이언트입니다. |
| KeyClient |
KeyClient는 Azure Key Vault에서 <xref:KeyVaultKey> 관리하는 메서드를 제공합니다. 클라이언트는 KeyVaultKeys 만들기, 검색, 업데이트, 삭제, 제거, 백업, 복원 및 나열을 지원합니다. 또한 클라이언트는 일시 삭제 사용 Azure Key Vault에 대한 <xref:DeletedKey> 나열하도록 지원합니다. |
인터페이스
| AesCbcDecryptParameters |
AES-CBC 암호화 알고리즘에 대한 암호 해독 매개 변수입니다. |
| AesCbcEncryptParameters |
AES-CBC 암호화 알고리즘에 대한 암호화 매개 변수입니다. |
| AesGcmDecryptParameters |
AES-GCM 암호화 알고리즘에 대한 암호 해독 매개 변수입니다. |
| AesGcmEncryptParameters |
AES-GCM 암호화 알고리즘에 대한 암호화 매개 변수입니다. |
| BackupKeyOptions |
<xref:backupKey>옵션. |
| BeginDeleteKeyOptions |
<xref:beginDeleteKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| BeginRecoverDeletedKeyOptions |
<xref:beginRecoverDeletedKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| CreateEcKeyOptions |
<xref:createEcKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| CreateKeyOptions |
<xref:createKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| CreateOctKeyOptions |
<xref:createOctKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| CreateRsaKeyOptions |
<xref:createRsaKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| CryptographyClientOptions |
KeyVault의 CryptographyClient에서 허용하는 선택적 매개 변수 |
| CryptographyOptions |
암호화 API 메서드의 옵션을 나타내는 인터페이스는 자세한 내용을 보려면 <xref:CryptographyClient> 이동합니다. |
| DecryptOptions |
<xref:decrypt>옵션. |
| DecryptResult |
<xref:decrypt> 작업의 결과입니다. |
| DeletedKey |
삭제된 Key Vault 키를 나타내는 인터페이스입니다. |
| EncryptOptions |
<xref:encrypt>옵션. |
| EncryptResult |
<xref:encrypt> 작업의 결과입니다. |
| GetDeletedKeyOptions |
<xref:getDeletedKey>옵션. |
| GetKeyOptions |
<xref:getKey>옵션. |
| ImportKeyOptions |
<xref:importKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| JsonWebKey | |
| KeyClientOptions |
KeyVault의 KeyClient에서 허용하는 선택적 매개 변수 |
| KeyPollerOptions |
<xref:beginDeleteKey> 및 <xref:beginRecoverDeletedKey> 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스입니다. |
| KeyProperties |
<xref:KeyVaultKey> 속성을 나타내는 인터페이스입니다. |
| KeyVaultKey |
이름, 값 및 <xref:KeyProperties>있는 Key Vault 키를 나타내는 인터페이스입니다. |
| KeyVaultKeyIdentifier |
Key Vault 키 ID를 작성하는 세그먼트를 나타냅니다. |
| ListDeletedKeysOptions |
<xref:listDeletedKeys>전달된 KeyClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다. |
| ListPropertiesOfKeyVersionsOptions |
<xref:listPropertiesOfKeyVersions>전달된 KeyClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다. |
| ListPropertiesOfKeysOptions |
<xref:listPropertiesOfKeys>전달된 KeyClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다. |
| PurgeDeletedKeyOptions |
<xref:purgeDeletedKey>옵션. |
| RestoreKeyBackupOptions |
<xref:restoreKeyBackup>옵션. |
| RsaDecryptParameters |
RSA 암호화 알고리즘에 대한 암호 해독 매개 변수입니다. |
| RsaEncryptParameters |
RSA 암호화 알고리즘에 대한 암호화 매개 변수입니다. |
| SignOptions |
<xref:sign>옵션. |
| SignResult |
<xref:sign> 작업의 결과입니다. |
| UnwrapKeyOptions |
<xref:unwrapKey>옵션. |
| UnwrapResult |
<xref:unwrap> 작업의 결과입니다. |
| UpdateKeyPropertiesOptions |
<xref:updateKeyProperties>옵션. |
| VerifyDataOptions |
<xref:verifyData> 옵션 |
| VerifyOptions |
<xref:verify>옵션. |
| VerifyResult |
<xref:verify> 작업의 결과입니다. |
| WrapKeyOptions |
<xref:wrapKey>옵션. |
| WrapResult |
<xref:wrap> 작업의 결과입니다. |
형식 별칭
| AesCbcEncryptionAlgorithm |
지원되는 모든 AES-CBC 암호화 알고리즘을 나타내는 공용 구조체 형식입니다. |
| AesGcmEncryptionAlgorithm |
지원되는 모든 AES-GCM 암호화 알고리즘을 나타내는 공용 구조체 형식입니다. |
| DecryptParameters |
다른 암호화 알고리즘에 적용할 때 현재 지원되는 모든 암호 해독 매개 변수를 나타내는 형식입니다. |
| DeletionRecoveryLevel |
DeletionRecoveryLevel에 대한 값을 정의합니다. 서비스에서 지원하는 값 파악
제거 가능: 삭제가 복구 가능하지 않고 되돌릴 수 없는 작업인 자격 증명 모음 상태를 표시합니다. 이 수준은 삭제 작업에 대해 사용할 수 있는 보호가 없음에 해당합니다. 엔터티 수준 이상(자격 증명 모음, 리소스 그룹, 구독 등)에서 삭제 작업을 수락하면 데이터가 돌이킬 수 없이 손실됩니다. |
| EncryptParameters |
현재 지원되는 모든 암호화 매개 변수를 다른 암호화 알고리즘에 적용할 때 나타내는 형식입니다. |
| EncryptionAlgorithm |
JsonWebKeyEncryptionAlgorithm에 대한 값을 정의합니다. 서비스에서 지원하는 값 파악RSA-OAEP |
| KeyCurveName |
JsonWebKeyCurveName에 대한 값을 정의합니다. 서비스에서 지원하는 값 파악
P-256: NIST P-256 타원 곡선, AKA SECG 곡선 SECP256R1. |
| KeyOperation |
JsonWebKeyOperation에 대한 값을 정의합니다. 서비스에서 지원하는 값 파악
암호화 |
| KeyType |
JsonWebKeyType에 대한 값을 정의합니다. 서비스에서 지원하는 값 파악
EC: 타원 곡선입니다. |
| KeyWrapAlgorithm |
키 래핑/래핑 해제에 지원되는 알고리즘 |
| RsaEncryptionAlgorithm |
지원되는 모든 RSA 암호화 알고리즘을 나타내는 공용 구조체 형식입니다. |
| SignatureAlgorithm |
JsonWebKeySignatureAlgorithm에 대한 값을 정의합니다. 서비스에서 지원하는 값 파악
PS256: https://tools.ietf.org/html/rfc7518 설명한 대로 SHA-256 및 MGF1을 SHA-256과 함께 사용하는 RSASSA-PSS |
열거형
| KnownDeletionRecoveryLevel |
서비스에서 허용하는 <xref:DeletionRecoveryLevel> 알려진 값입니다. |
| KnownEncryptionAlgorithms |
서비스에서 허용하는 <xref:JsonWebKeyEncryptionAlgorithm> 알려진 값입니다. |
| KnownKeyCurveNames |
서비스에서 허용하는 <xref:JsonWebKeyCurveName> 알려진 값입니다. |
| KnownKeyOperations |
서비스에서 허용하는 <xref:JsonWebKeyOperation> 알려진 값입니다. |
| KnownKeyTypes |
서비스에서 허용하는 <xref:JsonWebKeyType> 알려진 값입니다. |
| KnownSignatureAlgorithms |
서비스에서 허용하는 <xref:JsonWebKeySignatureAlgorithm> 알려진 값입니다. |
함수
| parse |
지정된 Key Vault 키 ID를 구문 분석합니다. 예를 들면 다음과 같습니다. https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id> 위의 ID를 구문 분석할 때 이 함수는 다음을 반환합니다. |
함수 세부 정보
parseKeyVaultKeyIdentifier(string)
지정된 Key Vault 키 ID를 구문 분석합니다. 예를 들면 다음과 같습니다. https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>
위의 ID를 구문 분석할 때 이 함수는 다음을 반환합니다.
{
sourceId: "https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id>",
vaultUrl: "https://<keyvault-name>.vault.azure.net",
version: "<unique-version-id>",
name: "<key-name>"
}
function parseKeyVaultKeyIdentifier(id: string)매개 변수
- id
-
string
Key Vault 키의 ID입니다.
