Aracılığıyla paylaş


@azure/keyvault-keys package

Sınıflar

CryptographyClient

Azure Key Vault anahtarında veya yerel bir JsonWebKey'de şifreleme işlemleri gerçekleştirmek için kullanılan bir istemci.

KeyClient

KeyClient, Azure Key Vault KeyVaultKey'i yönetmek için yöntemler sağlar. İstemci KeyVaultKeys oluşturma, alma, güncelleştirme, silme, temizleme, yedekleme, geri yükleme ve listelemeyi destekler. İstemci ayrıca geçici silme özelliği etkinleştirilmiş bir Azure Key Vault için DeletedKey listesini de destekler.

Arabirimler

AesCbcDecryptParameters

AES-CBC şifreleme algoritmaları için şifre çözme parametreleri.

AesCbcEncryptParameters

AES-CBC şifreleme algoritmaları için şifreleme parametreleri.

AesGcmDecryptParameters

AES-GCM şifreleme algoritmaları için şifre çözme parametreleri.

AesGcmEncryptParameters

AES-GCM şifreleme algoritmaları için şifreleme parametreleri.

BackupKeyOptions

için backupKey(string, BackupKeyOptions)seçenekler.

BeginDeleteKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim beginDeleteKey(string, BeginDeleteKeyOptions)

BeginRecoverDeletedKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

CreateEcKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim createEcKey(string, CreateEcKeyOptions)

CreateKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim createKey(string, string, CreateKeyOptions)

CreateOctKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim createOctKey(string, CreateOctKeyOptions)

CreateRsaKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim createRsaKey(string, CreateRsaKeyOptions)

CryptographyClientOptions

KeyVault CryptographyClient tarafından kabul edilen isteğe bağlı parametreler

CryptographyOptions

Şifreleme API yöntemlerinin seçeneklerini temsil eden bir arabirim, daha fazla bilgi için CryptographyClient'a gidin.

DecryptOptions

için decrypt(DecryptParameters, DecryptOptions)seçenekler.

DecryptResult

İşlemin sonucu decrypt(DecryptParameters, DecryptOptions) .

DeletedKey

Silinen Key Vault Anahtarını temsil eden bir arabirim.

EncryptOptions

için encrypt(EncryptParameters, EncryptOptions)seçenekler.

EncryptResult

İşlemin sonucu encrypt(EncryptParameters, EncryptOptions) .

GetCryptographyClientOptions

getCryptographyClient seçenekleri.

GetDeletedKeyOptions

için getDeletedKey(string, GetDeletedKeyOptions)seçenekler.

GetKeyOptions

için getKey(string, GetKeyOptions)seçenekler.

GetKeyRotationPolicyOptions

Seçenekleri: <xref:KeyClient.getRotationPolicy>

GetRandomBytesOptions

getRandomBytes seçenekleri

ImportKeyOptions

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim importKey(string, JsonWebKey_2, ImportKeyOptions)

JsonWebKey

Şu anda http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

KeyClientOptions

KeyVault KeyClient tarafından kabul edilen isteğe bağlı parametreler

KeyPollerOptions

ve'ye beginDeleteKey(string, BeginDeleteKeyOptions) geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

KeyProperties

KeyVaultKey Özelliklerini temsil eden bir arabirim

KeyReleasePolicy

Bir anahtarın altında dışarı aktarılabildiği ilke kuralları.

KeyRotationLifetimeAction

Bir anahtarın ömrü boyunca Key Vault tarafından gerçekleştirilecek bir eylem ve buna karşılık gelen tetikleyici.

KeyRotationPolicy

Bir anahtara ait tam anahtar döndürme ilkesi.

KeyRotationPolicyProperties

İstemcinin belirli bir anahtar için ayarlayabileceğiniz anahtar döndürme ilkesinin özellikleri.

Ayrıca lifetimeActions değerini boş bir diziye ayarlayarak anahtar döndürme ilkesini varsayılan değerlerine sıfırlayabilirsiniz.

KeyVaultKey

adı, değeri ve KeyProperties ile Key Vault Anahtarını temsil eden bir arabirim.

KeyVaultKeyIdentifier

Key Vault Anahtar Kimliği oluşturan kesimleri temsil eder.

ListDeletedKeysOptions

Öğesine geçirilen listDeletedKeys(ListDeletedKeysOptions)KeyClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.

ListPropertiesOfKeyVersionsOptions

Öğesine geçirilen listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)KeyClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.

ListPropertiesOfKeysOptions

Öğesine geçirilen listPropertiesOfKeys(ListPropertiesOfKeysOptions)KeyClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.

PageSettings

Sayfalanmış yineleme ayarlarını izleyen bir arabirim

PagedAsyncIterableIterator

Hem tamamlamaya hem de sayfaya göre zaman uyumsuz yinelenebilir yinelemeye izin veren bir arabirim.

PollOperationState

PollOperationState, uzun süre çalışan işlem poller'lerini tanımlamak için gereken en küçük özellik kümesinin bir listesini içerir.

Poller sınıfı, uzun süre çalışan bir işlemi tetikleme, bekleme ve potansiyel olarak iptal etme amacıyla yerel denetim mekanizması olarak çalışsa da PollOperationState, uzak uzun süre çalışan işlemin durumunu belgeler.

En azından işlem başladığında, tamamlandığında ve iptal edildiğinde güncelleştirilmelidir. Ancak, uygulamalar başka nedenlerle güncelleştirilebilecek başka sayıda özelliğe sahip olabilir.

PollerLike

Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amacıyla bir poller'in soyut gösterimi.

PurgeDeletedKeyOptions

için purgeDeletedKey(string, PurgeDeletedKeyOptions)seçenekler.

ReleaseKeyOptions

releaseKey seçenekleri

ReleaseKeyResult

releaseKey işleminin sonucu.

RestoreKeyBackupOptions

için restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)seçenekler.

RotateKeyOptions

rotateKey seçenekleri

RsaDecryptParameters

RSA şifreleme algoritmaları için şifre çözme parametreleri.

RsaEncryptParameters

RSA şifreleme algoritmaları için şifreleme parametreleri.

SignOptions

için sign(string, Uint8Array, SignOptions)seçenekler.

SignResult

İşlemin sonucu sign(string, Uint8Array, SignOptions) .

UnwrapKeyOptions

için unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)seçenekler.

UnwrapResult

İşlemin sonucu <xref:unwrap> .

UpdateKeyPropertiesOptions

için updateKeyProperties(string, string, UpdateKeyPropertiesOptions)seçenekler.

UpdateKeyRotationPolicyOptions

updateKeyRotationPolicy seçenekleri

VerifyDataOptions

Seçenekleri: verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

VerifyOptions

için verify(string, Uint8Array, Uint8Array, VerifyOptions)seçenekler.

VerifyResult

İşlemin sonucu verify(string, Uint8Array, Uint8Array, VerifyOptions) .

WrapKeyOptions

için wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)seçenekler.

WrapResult

İşlemin sonucu <xref:wrap> .

Tür Diğer Adları

AesCbcEncryptionAlgorithm

Desteklenen tüm AES-CBC şifreleme algoritmalarını temsil eden birleşim türü.

AesGcmEncryptionAlgorithm

Desteklenen tüm AES-GCM şifreleme algoritmalarını temsil eden birleşim türü.

DecryptParameters

Şu anda desteklenen tüm şifre çözme parametrelerini farklı şifreleme algoritmalarına uygulandığında temsil eden bir tür.

DeletionRecoveryLevel

DeletionRecoveryLevel değerlerini tanımlar.
KnownDeletionRecoveryLevel, DeletionRecoveryLevel ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

Temizlenebilir: Kurtarma olasılığı olmadan silme işleminin geri alınamaz bir işlem olduğu bir kasa durumunu belirtir. Bu düzey, Silme işlemine karşı kullanılabilir koruma olmamasını ifade eder; varlık düzeyinde veya daha yüksek bir düzeyde (kasa, kaynak grubu, abonelik vb.) silme işlemi kabul edildikten sonra veriler kurtarılamaz şekilde kaybolur.
Kurtarılabilir+Temizlenebilir: Silme işleminin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye (temizleme) izin veren bir kasa durumunu belirtir. Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme aralığı (90 gün) boyunca silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Kurtarılabilir: Silme işleminin anında ve kalıcı silme (temizleme) olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir. Bu düzey, saklama aralığı (90 gün) ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Recoverable+ProtectedSubscription: Silme işleminin saklama aralığı (90 gün) içinde kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
CustomizedRecoverable+Purgeable: Silme işleminin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable: Silme işleminin anında ve kalıcı silme olanağı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama aralığı boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable+ProtectedSubscription: 7<= SoftDeleteRetentionInDays < 90 olduğunda kurtarma, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasayı ve abonelik durumunu belirtir. Bu düzey, bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediğini yansıtır.

EncryptParameters

Şu anda desteklenen tüm şifreleme parametrelerini farklı şifreleme algoritmalarına uygulandığında temsil eden bir tür.

EncryptionAlgorithm

JsonWebKeyEncryptionAlgorithm değerlerini tanımlar.
<xref:KnownJsonWebKeyEncryptionAlgorithm> JsonWebKeyEncryptionAlgorithm ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

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

KeyCurveName

JsonWebKeyCurveName değerlerini tanımlar.
<xref:KnownJsonWebKeyCurveName> JsonWebKeyCurveName ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

P-256: NIST P-256 üç nokta eğrisi, DIĞER adıyla SECG eğrisi SECP256R1.
P-384: NIST P-384 elips eğrisi, SECG eğrisi SECP384R1.
P-521: NIST P-521 üç nokta eğrisi, DIĞER adıyla SECG eğrisi SECP521R1.
P-256K: SECG SECP256K1 üç nokta eğrisi.

KeyExportEncryptionAlgorithm

KeyEncryptionAlgorithm değerlerini tanımlar. KnownKeyExportEncryptionAlgorithm , KeyEncryptionAlgorithm ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

KeyOperation

JsonWebKeyOperation değerlerini tanımlar.
<xref:KnownJsonWebKeyOperation> JsonWebKeyOperation ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

Şifrelemek
Şifre -sini çöz
sign
verify
wrapKey
unwrapKey
Ithalat
Ihracat

KeyRotationPolicyAction

Yürütülecek eylem.

KeyType

JsonWebKeyType değerlerini tanımlar.
<xref:KnownJsonWebKeyType> JsonWebKeyType ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

EC: Elips Eğrisi.
EC-HSM: HSM'de depolanan özel anahtarla üç nokta eğrisi.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: HSM'de depolanan özel anahtarla RSA.
oct: Sekizli sıra (simetrik anahtarları temsil etmek için kullanılır)
oct-HSM: HSM'de depolanan sekizli dizi (simetrik anahtarları temsil etmek için kullanılır).

KeyWrapAlgorithm

Anahtar sarmalama/kaldırma için desteklenen algoritmalar

RsaEncryptionAlgorithm

Desteklenen tüm RSA şifreleme algoritmalarını temsil eden birleşim türü.

SignatureAlgorithm

JsonWebKeySignatureAlgorithm değerlerini tanımlar.
<xref:KnownJsonWebKeySignatureAlgorithm> JsonWebKeySignatureAlgorithm ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

PS256: SHA-256 kullanan RSASSA-PSS ve SHA-256 ile MGF1, aşağıda açıklandığı gibi https://tools.ietf.org/html/rfc7518
PS384: SHA-384 kullanan RSASSA-PSS ve SHA-384 ile MGF1, aşağıda açıklandığı gibi https://tools.ietf.org/html/rfc7518
PS512: SHA-512 kullanan RSASSA-PSS ve SHA-512 ile MGF1, aşağıda açıklandığı gibi https://tools.ietf.org/html/rfc7518
RS256: SHA-256 kullanan RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RS384: SHA-384 kullanarak RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RS512: SHA-512 kullanan RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RSNULL: Ayrılmış
ES256: içinde açıklandığı https://tools.ietf.org/html/rfc7518gibi P-256 ve SHA-256 kullanan ECDSA.
ES384: P-384 ve SHA-384 kullanan ECDSA, https://tools.ietf.org/html/rfc7518
ES512: P-521 ve SHA-512 kullanan ECDSA, https://tools.ietf.org/html/rfc7518
ES256K: P-256K ve SHA-256 kullanan ECDSA, https://tools.ietf.org/html/rfc7518

Numaralandırmalar

KnownDeletionRecoveryLevel

Hizmetin kabul ettiğini Bilinen DeletionRecoveryLevel değerleri.

KnownEncryptionAlgorithms

Hizmetin kabul ettiğini bilinen EncryptionAlgorithm değerleri.

KnownKeyCurveNames

Hizmetin kabul edildiği bilinen değerler <xref:JsonWebKeyCurveName> .

KnownKeyExportEncryptionAlgorithm

Hizmetin kabul ettiğini bilinen KeyExportEncryptionAlgorithm değerleri.

KnownKeyOperations

Hizmetin kabul ettiğini bilinen KeyOperation değerleri.

KnownKeyTypes

Hizmetin kabul edildiği bilinen değerler <xref:JsonWebKeyType> .

KnownSignatureAlgorithms

Hizmetin kabul edildiği bilinen değerler <xref:JsonWebKeySignatureAlgorithm> .

İşlevler

parseKeyVaultKeyIdentifier(string)

Verilen Key Vault Anahtar Kimliğini ayrıştırıyor. Örnek olarak:

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

Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür:

  {
     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>"
  }

İşlev Ayrıntıları

parseKeyVaultKeyIdentifier(string)

Verilen Key Vault Anahtar Kimliğini ayrıştırıyor. Örnek olarak:

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

Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür:

  {
     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

Parametreler

id

string

Key Vault Anahtarının Kimliği.

Döndürülenler