@azure/keyvault-keys package

클래스

CryptographyClient

Azure Key Vault 키 또는 로컬 JsonWebKey에서 암호화 작업을 수행하는 데 사용되는 클라이언트입니다.

KeyClient

KeyClient는 Azure Key Vault KeyVaultKey를 관리하는 메서드를 제공합니다. 클라이언트는 KeyVaultKeys 만들기, 검색, 업데이트, 삭제, 제거, 백업, 복원 및 나열을 지원합니다. 또한 클라이언트는 일시 삭제를 사용하도록 설정된 Azure Key Vault 대해 DeletedKey 목록을 지원합니다.

인터페이스

AesCbcDecryptParameters

AES-CBC 암호화 알고리즘에 대한 암호 해독 매개 변수입니다.

AesCbcEncryptParameters

AES-CBC 암호화 알고리즘에 대한 암호화 매개 변수입니다.

AesGcmDecryptParameters

AES-GCM 암호화 알고리즘에 대한 암호 해독 매개 변수입니다.

AesGcmEncryptParameters

AES-GCM 암호화 알고리즘에 대한 암호화 매개 변수입니다.

BackupKeyOptions

에 대한 옵션입니다 backupKey(string, BackupKeyOptions).

BeginDeleteKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginDeleteKey(string, BeginDeleteKeyOptions)

BeginRecoverDeletedKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

CreateEcKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 createEcKey(string, CreateEcKeyOptions)

CreateKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 createKey(string, string, CreateKeyOptions)

CreateOctKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 createOctKey(string, CreateOctKeyOptions)

CreateRsaKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 createRsaKey(string, CreateRsaKeyOptions)

CryptographyClientOptions

KeyVault의 CryptographyClient에서 허용하는 선택적 매개 변수

CryptographyOptions

암호화 API 메서드의 옵션을 나타내는 인터페이스로, 자세한 내용은 CryptographyClient 로 이동합니다.

DecryptOptions

에 대한 옵션입니다 decrypt(DecryptParameters, DecryptOptions).

DecryptResult

작업의 결과입니다 decrypt(DecryptParameters, DecryptOptions) .

DeletedKey

삭제된 Key Vault 키를 나타내는 인터페이스입니다.

EncryptOptions

에 대한 옵션입니다 encrypt(EncryptParameters, EncryptOptions).

EncryptResult

작업의 결과입니다 encrypt(EncryptParameters, EncryptOptions) .

GetCryptographyClientOptions

getCryptographyClient에 대한 옵션입니다.

GetDeletedKeyOptions

에 대한 옵션입니다 getDeletedKey(string, GetDeletedKeyOptions).

GetKeyOptions

에 대한 옵션입니다 getKey(string, GetKeyOptions).

GetKeyRotationPolicyOptions

<xref:KeyClient.getRotationPolicy>에 대한 옵션입니다.

GetRandomBytesOptions

getRandomBytes 옵션

ImportKeyOptions

전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 importKey(string, JsonWebKey_2, ImportKeyOptions)

JsonWebKey

현재 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

KeyClientOptions

KeyVault의 KeyClient에서 허용하는 선택적 매개 변수

KeyPollerOptions

및 에 전달할 수 있는 선택적 매개 변수를 beginDeleteKey(string, BeginDeleteKeyOptions) 나타내는 인터페이스 beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

KeyProperties

KeyVaultKey의 속성을 나타내는 인터페이스

KeyReleasePolicy

키를 내보낼 수 있는 정책 규칙입니다.

KeyRotationLifetimeAction

키 수명 동안 Key Vault 수행할 작업 및 해당 트리거입니다.

KeyRotationPolicy

키에 속하는 전체 키 회전 정책입니다.

KeyRotationPolicyProperties

클라이언트가 지정된 키에 대해 설정할 수 있는 키 회전 정책의 속성입니다.

lifetimeActions를 빈 배열로 설정하여 키 회전 정책을 기본값으로 다시 설정할 수도 있습니다.

KeyVaultKey

이름, 값 및 KeyProperties가 있는 Key Vault 키를 나타내는 인터페이스입니다.

KeyVaultKeyIdentifier

Key Vault 키 ID를 구성하는 세그먼트를 나타냅니다.

ListDeletedKeysOptions

에 전달된 listDeletedKeys(ListDeletedKeysOptions)KeyClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.

ListPropertiesOfKeyVersionsOptions

에 전달된 listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)KeyClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.

ListPropertiesOfKeysOptions

에 전달된 listPropertiesOfKeys(ListPropertiesOfKeysOptions)KeyClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.

PageSettings

페이징된 반복에 대한 설정을 추적하는 인터페이스

PagedAsyncIterableIterator

완료 및 페이지별 비동기 반복을 허용하는 인터페이스입니다.

PollOperationState

PollOperationState에는 장기 실행 작업 폴러를 정의하는 데 필요한 가장 작은 속성 집합의 의견 목록이 포함되어 있습니다.

Poller 클래스는 트리거를 시작하고, 대기하고, 잠재적으로 장기 실행 작업을 취소하는 로컬 제어 메커니즘으로 작동하지만, PollOperationState는 원격 장기 실행 작업의 상태를 문서화합니다.

작업이 시작될 때, 완료된 경우 및 취소될 때 적어도 업데이트해야 합니다. 그러나 구현에는 다른 이유로 업데이트할 수 있는 다른 수의 속성이 있을 수 있습니다.

PollerLike

사용자가 작업해야 하는 최소 API만 노출하기 위한 폴러의 추상 표현입니다.

PurgeDeletedKeyOptions

에 대한 옵션입니다 purgeDeletedKey(string, PurgeDeletedKeyOptions).

ReleaseKeyOptions

releaseKey에 대한 옵션

ReleaseKeyResult

releaseKey 작업의 결과입니다.

RestoreKeyBackupOptions

에 대한 옵션입니다 restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

RotateKeyOptions

rotateKey 옵션

RsaDecryptParameters

RSA 암호화 알고리즘에 대한 암호 해독 매개 변수입니다.

RsaEncryptParameters

RSA 암호화 알고리즘에 대한 암호화 매개 변수입니다.

SignOptions

에 대한 옵션입니다 sign(string, Uint8Array, SignOptions).

SignResult

작업의 결과입니다 sign(string, Uint8Array, SignOptions) .

UnwrapKeyOptions

에 대한 옵션입니다 unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

UnwrapResult

작업의 결과입니다 <xref:unwrap> .

UpdateKeyPropertiesOptions

에 대한 옵션입니다 updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

UpdateKeyRotationPolicyOptions

updateKeyRotationPolicy 옵션

VerifyDataOptions

verifyData(string, Uint8Array, Uint8Array, VerifyOptions)에 대한 옵션입니다.

VerifyOptions

에 대한 옵션입니다 verify(string, Uint8Array, Uint8Array, VerifyOptions).

VerifyResult

작업의 결과입니다 verify(string, Uint8Array, Uint8Array, VerifyOptions) .

WrapKeyOptions

에 대한 옵션입니다 wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

WrapResult

작업의 결과입니다 <xref:wrap> .

형식 별칭

AesCbcEncryptionAlgorithm

지원되는 모든 AES-CBC 암호화 알고리즘을 나타내는 공용 구조체 형식입니다.

AesGcmEncryptionAlgorithm

지원되는 모든 AES-GCM 암호화 알고리즘을 나타내는 공용 구조체 형식입니다.

DecryptParameters

다른 암호화 알고리즘에 적용할 때 현재 지원되는 모든 암호 해독 매개 변수를 나타내는 형식입니다.

DeletionRecoveryLevel

DeletionRecoveryLevel에 대한 값을 정의합니다.
KnownDeletionRecoveryLevel 은 DeletionRecoveryLevel과 서로 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

제거 가능: 삭제가 복구할 가능성 없이 되돌릴 수 없는 작업인 자격 증명 모음 상태를 표시합니다. 이 수준은 삭제 작업에 대해 사용할 수 있는 보호가 없음에 해당합니다. 엔터티 수준 이상(자격 증명 모음, 리소스 그룹, 구독 등)에서 삭제 작업을 수락하면 데이터가 돌이킬 수 없을 정도로 손실됩니다.
복구 가능+제거 가능: 삭제를 복구할 수 있는 자격 증명 모음 상태를 표시하며 즉시 영구 삭제(즉, 제거)도 허용합니다. 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격(90일) 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다.
복구 가능: 즉시 영구 삭제(즉, 제거)할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다. 이 수준은 보존 간격(90일)과 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다.
Recoveryable+ProtectedSubscription: 보존 간격(90일) 내에 삭제를 복구할 수 있고, 즉시 및 영구 삭제(즉, 제거)가 허용되지 않으며 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다.
CustomizedRecoverable+Purgeable: 삭제를 복구할 수 있는 자격 증명 모음 상태를 표시하며 즉시 영구 삭제를 허용합니다(즉, 7<= SoftDeleteRetentionInDays < 90일 때 제거). 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장합니다.
CustomizedRecoverable: 즉시 영구 삭제할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다(예: 7<= SoftDeleteRetentionInDays < 90인 경우 제거). 이 수준은 보존 간격 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다.
CustomizedRecoverable+ProtectedSubscription: 삭제가 복구 가능하고, 즉각적이고 영구적인 삭제(즉, 제거)가 허용되지 않으며, 7<= SoftDeleteRetentionInDays < 90일 때 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 이 수준은 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장하며 구독 자체를 취소할 수 없다는 사실도 반영합니다.

EncryptParameters

현재 지원되는 모든 암호화 매개 변수를 다른 암호화 알고리즘에 적용하는 형식입니다.

EncryptionAlgorithm

JsonWebKeyEncryptionAlgorithm에 대한 값을 정의합니다.
<xref:KnownJsonWebKeyEncryptionAlgorithm> 는 JsonWebKeyEncryptionAlgorithm과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

KeyCurveName

JsonWebKeyCurveName에 대한 값을 정의합니다.
<xref:KnownJsonWebKeyCurveName> 는 JsonWebKeyCurveName과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

P-256: NIST P-256 타원 곡선, AKA SECG 곡선 SECP256R1.
P-384: NIST P-384 타원 곡선, AKA SECG 곡선 SECP384R1.
P-521: NIST P-521 타원 곡선, AKA SECG 곡선 SECP521R1.
P-256K: SECG SECP256K1 타원 곡선입니다.

KeyExportEncryptionAlgorithm

KeyEncryptionAlgorithm에 대한 값을 정의합니다. KnownKeyExportEncryptionAlgorithm 은 KeyEncryptionAlgorithm과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

KeyOperation

JsonWebKeyOperation에 대한 값을 정의합니다.
<xref:KnownJsonWebKeyOperation> 는 JsonWebKeyOperation과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export

KeyRotationPolicyAction

실행할 작업입니다.

KeyType

JsonWebKeyType에 대한 값을 정의합니다.
<xref:KnownJsonWebKeyType> 는 JsonWebKeyType과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

EC: 타원 곡선.
EC-HSM: HSM에 저장된 프라이빗 키가 있는 타원 곡선입니다.
RSA: RSA(https://tools.ietf.org/html/rfc3447)
RSA-HSM: HSM에 저장된 프라이빗 키가 있는 RSA입니다.
oct: Octet 시퀀스(대칭 키를 나타내는 데 사용됨)
oct-HSM: HSM을 저장하는 옥릿 시퀀스(대칭 키를 나타내는 데 사용됨)

KeyWrapAlgorithm

키 래핑/래핑 해제에 지원되는 알고리즘

RsaEncryptionAlgorithm

지원되는 모든 RSA 암호화 알고리즘을 나타내는 공용 구조체 형식입니다.

SignatureAlgorithm

JsonWebKeySignatureAlgorithm에 대한 값을 정의합니다.
<xref:KnownJsonWebKeySignatureAlgorithm> 는 JsonWebKeySignatureAlgorithm과 서로 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다.

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

PS256: 에 설명된 대로 SHA-256 및 MGF1을 사용하는 SHA-256 및 MGF1을 사용하는 RSASSA-PSS https://tools.ietf.org/html/rfc7518
PS384: SHA-384와 함께 SHA-384 및 MGF1을 사용하는 RSASSA-PSS(에 설명된 대로) https://tools.ietf.org/html/rfc7518
PS512: 에 설명된 대로 SHA-512 및 SHA-512와 함께 MGF1을 사용하는 RSASSA-PSS https://tools.ietf.org/html/rfc7518
RS256: 에 설명된 대로 SHA-256을 사용하는 RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RS384: 에 설명된 대로 SHA-384를 사용하는 RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RS512: 에 설명된 대로 SHA-512를 사용하는 RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RSNULL: 예약됨
ES256: 에 설명된 https://tools.ietf.org/html/rfc7518대로 P-256 및 SHA-256을 사용하는 ECDSA
ES384: 에 설명된 대로 P-384 및 SHA-384를 사용하는 ECDSA https://tools.ietf.org/html/rfc7518
ES512: 에 설명된 대로 P-521 및 SHA-512를 사용하는 ECDSA https://tools.ietf.org/html/rfc7518
ES256K: 에 설명된 대로 P-256K 및 SHA-256을 사용하는 ECDSA https://tools.ietf.org/html/rfc7518

열거형

KnownDeletionRecoveryLevel

서비스에서 허용하는 DeletionRecoveryLevel 의 알려진 값입니다.

KnownEncryptionAlgorithms

서비스에서 허용하는 EncryptionAlgorithm 의 알려진 값입니다.

KnownKeyCurveNames

서비스에서 허용하는 의 <xref:JsonWebKeyCurveName> 알려진 값입니다.

KnownKeyExportEncryptionAlgorithm

서비스에서 허용하는 KeyExportEncryptionAlgorithm 의 알려진 값입니다.

KnownKeyOperations

서비스에서 허용하는 KeyOperation 의 알려진 값입니다.

KnownKeyTypes

서비스에서 허용하는 의 <xref:JsonWebKeyType> 알려진 값입니다.

KnownSignatureAlgorithms

서비스에서 허용하는 의 <xref:JsonWebKeySignatureAlgorithm> 알려진 값입니다.

함수

parseKeyVaultKeyIdentifier(string)

지정된 Key Vault 키 ID를 구문 분석합니다. 예를 들면 다음과 같습니다.

https://.vault.azure.net/keys//

위의 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>"
  }

함수 세부 정보

parseKeyVaultKeyIdentifier(string)

지정된 Key Vault 키 ID를 구문 분석합니다. 예를 들면 다음과 같습니다.

https://.vault.azure.net/keys//

위의 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): KeyVaultKeyIdentifier

매개 변수

id

string

Key Vault 키의 ID입니다.

반환