@azure/keyvault-certificates package

Sınıflar

CertificateClient

KeyVault sertifikaları işlevselliğiyle etkileşime geçmek için istemci

Arabirimler

AdministratorContact	Sertifika verenin kuruluş yöneticisinin ayrıntıları.
BackupCertificateResult	Yedekleme blobunu içeren yedekleme sertifikası sonucu.
BeginCreateCertificateOptions	beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CertificateClientOptions	KeyVault'un CertificateClient tarafından kabul edilen isteğe bağlı parametreler
CertificateContactAll	Kasa sertifikaları için kişi bilgilerinin şekli.
CertificateIssuer	Verenin özelliklerini temsil eden arabirim.
CertificateOperation	Zaman uyumsuz istekler durumunda bir sertifika işlemi döndürülür.
CertificateOperationError	Anahtar kasası sunucusu hatası.
CertificateOperationState	CertificateOperationPoller durumunun genel kullanıma açık özelliklerini temsil eden bir arabirim.
CertificatePolicyProperties	Sertifikanın ilkesini temsil eden arabirim (konu özellikleri olmadan).
CertificatePollerOptions	beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) ve beginRecoverDeletedCertificate(string, CertificatePollerOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CertificateProperties	Sertifikanın özelliklerini temsil eden arabirim
CoreSubjectAlternativeNames	X509 nesnesinin konu alternatif adları.
CreateCertificateOptions	<xref:createCertificate>seçenekleri.
CreateIssuerOptions	createIssuer(string, string, CreateIssuerOptions)seçenekleri.
DeletedCertificate	Silinen sertifikayı temsil eden arabirim.
ErrorModel	Anahtar kasası sunucusu hata modeli.
ImportCertificateOptions	importCertificate(string, Uint8Array, ImportCertificateOptions)seçenekleri.
IssuerAttributes	Key Vault servisi tarafından yönetilen bir ihraççının özellikleri.
IssuerCredentials	Sertifikayı veren için kullanılacak kimlik bilgileri.
IssuerParameters	Bir sertifikanın X509 bileşenini verenin parametreleri.
IssuerProperties	Sertifika verenin özelliklerini temsil eden arabirim
KeyVaultCertificate	Sertifika ilkesi olmayan bir sertifikayı temsil eden arabirim
KeyVaultCertificateIdentifier	Key Vault Sertifika Kimliği'ni oluşturan segmentleri temsil eder.
KeyVaultCertificatePollOperationState	Key Vault Sertifika Anketörünün operasyonlarının durumunun kamuya açık biçimini temsil eden bir arayüz.
KeyVaultCertificateWithPolicy	İlkesine sahip bir sertifikayı temsil eden arabirim
LifetimeAction	Bir sertifikanın ömrü boyunca Key Vault tarafından gerçekleştirilecek eylem ve tetikleyici.
ListDeletedCertificatesOptions	listDeletedCertificates(ListDeletedCertificatesOptions)'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
ListPropertiesOfCertificatesOptions	listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
PolicySubjectProperties	Sertifika ilkesinin olası konu özelliklerini temsil eden arabirim. Son tür, bu özelliklerden en az birinin mevcut olmasını gerektirir.
PollerLike	Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amaçlı bir poller'in soyut gösterimi.
PollerLikeWithCancellation	Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amaçlı bir poller'in soyut gösterimi.
SubjectAlternativeNamesAll	Sertifika ilkesinin konusunun alternatif adlarını temsil eden arabirim.
UpdateCertificateOptions	<xref:updateCertificate>seçenekleri.
UpdateIssuerOptions	updateIssuer(string, UpdateIssuerOptions)seçenekleri.
X509CertificateProperties	Bir sertifikanın X509 bileşeninin özellikleri.

Tür Diğer Adları

ActionType	Yürütülecek eylem.
ArrayOneOrMore	En az bir özelliği olan bir dizi.
BackupCertificateOptions	backupCertificate(string, OperationOptions)seçenekleri.
BeginDeleteCertificateOptions	beginDeleteCertificate(string, CertificatePollerOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
BeginRecoverDeletedCertificateOptions	beginRecoverDeletedCertificate(string, CertificatePollerOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CancelCertificateOperationOptions	<xref:cancelCertificateOperation>seçenekleri.
CertificateContact	Kasa sertifikaları için iletişim bilgileri. Her kişi CertificateContactAll özelliklerinden en az birine sahip olur; bunlar: emailAddress, name veya phone.
CertificateContentType	contentType değerlerini tanımlar. Olası değerler şunlardır: 'application/x-pem-file', 'application/x-pkcs12'
CertificateKeyCurveName	Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName. <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, SECG eğrisi SECP256R1. P-384: NIST P-384 üç nokta eğrisi, SECG eğrisi SECP384R1. P-521: NIST P-521 üç nokta eğrisi, SECG eğrisi SECP521R1. P-256K: SECG üç nokta eğrisi SECP256K1.
CertificateKeyType	Sertifika için kullanılacak anahtar çiftinin türü. <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'den dışarı aktarılamayan özel anahtara sahip Üç Nokta Eğrisi. RSA: RSA (https://tools.ietf.org/html/rfc3447). RSA-HSM: HSM'den dışarı aktarılamayan özel anahtara sahip RSA. ekim: Sekizli sıra (simetrik anahtarları temsil etmek için kullanılır). oct-HSM: HSM'den dışarı aktarılamayan özel anahtara sahip sekizli sıra.
CertificatePolicy	Konu özelliklerinden en az biriyle sertifikanın ilkesini temsil eden bir tür.
CertificatePolicyAction	Yürütülecek eylem.
CertificateTags	Sertifika Etiketlerinin şeklini temsil eden bir arabirim. Etiketler yalnızca dize anahtar-değer çiftleridir.
CreateCertificateState	CreateCertificatePoller işlem durumunun genel gösterimi.
DeleteCertificateOperationOptions	deleteCertificateOperation(string, OperationOptions)seçenekleri.
DeleteCertificateState	DeleteCertificatePoller işlem durumunun genel gösterimi.
DeleteContactsOptions	deleteContacts(OperationOptions)seçenekleri.
DeleteIssuerOptions	deleteIssuer(string, OperationOptions)seçenekleri.
DeletionRecoveryLevel	Geçerli kasadaki gizli diziler için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa gizli dizi ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda gizli diziyi yalnızca sistem temizleyebilir. <xref: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 olanağı olmadan silme işleminin geri alınamaz bir işlem olduğu kasa durumunu belirtir. Bu düzey, silme işlemine karşı kullanılabilir koruma olmamasına karşılık gelir; 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. Recoverable+Purgeable: Silmenin 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 saklama 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 edilemeyeceği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler CustomizedRecoverable+Purgeable: Silmenin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (örneğin, 7 <= SoftDeleteRetentionInDays < 90). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama 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: 90 < 7 <= SoftDeleteRetentionInDays olduğunda silinmeye izin verilmeyen, anında ve kalıcı silmeye (temizleme) izin verilmeyen ve aboneliğin kendisinin kalıcı olarak iptal edilemeyeceğ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.
GetCertificateOperationOptions	getCertificateOperation(string, CertificatePollerOptions)seçenekleri.
GetCertificateOptions	getCertificate(string, OperationOptions)seçenekleri.
GetCertificatePolicyOptions	getCertificatePolicy(string, OperationOptions)seçenekleri.
GetCertificateVersionOptions	getCertificateVersion(string, string, OperationOptions)seçenekleri.
GetContactsOptions	getContacts(OperationOptions)seçenekleri.
GetDeletedCertificateOptions	getDeletedCertificate(string, OperationOptions)seçenekleri.
GetIssuerOptions	getIssuer(string, OperationOptions)seçenekleri.
GetPlainCertificateOperationOptions	<xref:getPlainCertificateOperation>seçenekleri.
ImportCertificatePolicy	Sertifikanın içeri aktarma ilkesini temsil eden ve SAN veya Konu gerektirmeyen bir tür
KVPollerLike	Core-lro'nun PollerLike dosyasının KeyVault kopyası kullanım dışı bırakıldı.
KeyUsageType	Sertifika anahtarının desteklenen kullanımları. <xref:KnownKeyUsageType> KeyUsageType ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler digitalSignature: Sertifika anahtarının dijital imza olarak kullanılabileceğini gösterir. nonRepudiation: Sertifika anahtarının kimlik doğrulaması için kullanılabileceğini gösterir. keyEncipherment: Sertifika anahtarının anahtar şifrelemesi için kullanılabileceğini gösterir. dataEncipherment: Sertifika anahtarının veri şifrelemesi için kullanılabileceğini gösterir. keyAgreement : Sertifika anahtarının, Diffie-Hellman anahtar sözleşmesi algoritması kullanılarak oluşturulan anahtar gibi anahtar sözleşmesini belirlemek için kullanılabileceğini gösterir. keyCertSign: Sertifika anahtarının sertifikaları imzalamak için kullanılabileceğini gösterir. cRLSign: Sertifika anahtarının bir sertifika iptal listesini imzalamak için kullanılabileceğini gösterir. encipherOnly: Sertifika anahtarının yalnızca şifreleme için kullanılabileceğini gösterir. decipherOnly: Sertifika anahtarının yalnızca şifre çözme için kullanılabileceğini gösterir.
ListPropertiesOfCertificateVersionsOptions	listPropertiesOfCertificateVersions(string, OperationOptions)'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
ListPropertiesOfIssuersOptions	listPropertiesOfIssuers(OperationOptions)'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
MergeCertificateOptions	mergeCertificate(string, Uint8Array[], OperationOptions)için isteğe bağlı parametreleri temsil eden bir arabirim.
PurgeDeletedCertificateOptions	purgeDeletedCertificate(string, OperationOptions)seçenekleri.
RecoverDeletedCertificateState	Kullanım dışı: Silinen sertifika yoklama işleminin kurtarılmasının genel gösterimi
RequireAtLeastOne	RequireAtLeastOne, arabirimin özelliklerinden en az birinin (herhangi bir özellik olabilir) bulunması gereken bir tür oluşturulmasına yardımcı olur. Bu, TypeScript'in yardımcı program türleri nedeniyle çalışır: https://www.typescriptlang.org/docs/handbook/utility-types.html Şimdi inceleyelim: [K in keyof T]-? bu özellik (K) yalnızca T'nin herhangi bir özelliğiyle aynı ada sahipse geçerlidir. Required<Pick<T, K>>, yinelemede yalnızca geçerli özelliğiyle T'den yeni bir tür oluşturur ve gerekli olarak işaretler Partial<Pick<T, Exclude<keyof T, K>>>, K özelliği dışında T'nin tüm özellikleriyle yeni bir tür oluşturur. & türü, Required<...>'in tüm isteğe bağlı özellikleriyle Partial<...>'den yalnızca bir gerekli özellik ile birleştiren özelliktir. [keyof T] yalnızca T özelliklerine izin verildiğinden emin olur.
RestoreCertificateBackupOptions	restoreCertificateBackup(Uint8Array, OperationOptions)için isteğe bağlı parametreleri temsil eden bir arabirim.
SetContactsOptions	setContacts(CertificateContact[], OperationOptions)seçenekleri.
SubjectAlternativeNames	Konu özelliğine alternatifler. Varsa, SubjectAlternativeNamesAll özelliklerinden en az birine sahip olmalıdır.
UpdateCertificatePolicyOptions	updateCertificatePolicy(string, CertificatePolicy, OperationOptions)seçenekleri.

Numaralandırmalar

KnownCertificateKeyCurveNames	Hizmetin kabul CertificateKeyCurveName bilinen değerleri.
KnownCertificateKeyTypes	CertificateKeyType'ın bilinen değerleri, hizmetin kabul.
KnownDeletionRecoveryLevels	Geçerli kasadaki gizli diziler için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa gizli dizi ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda gizli diziyi yalnızca sistem temizleyebilir.
KnownKeyUsageTypes	Hizmetin kabul KeyUsageType'ın bilinen değerleri.
WellKnownIssuer	Varsayılanı seçmek için iyi bilinen verenler

İşlevler

parseKeyVaultCertificateIdentifier(string)

Verilen Key Vault Sertifika Kimliğini ayrıştırır. Bir örnek: https://< keyvault-name.vault.azure.net/certificates/>< sertifika-adı>/<unique-version-id> Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür: { sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>", vaultUrl: "https://<keyvault-name>.vault.azure.net", version: "<unique-version-id>", name: "<certificate-name>" }

Değişkenler

DefaultCertificatePolicy	DefaultCertificatePolicy, varsayılan parametreler olarak faydalı olan değerleri sertifikanın politikasını değiştiren yöntemlere dışa aktarır.
logger

İşlev Ayrıntıları

parseKeyVaultCertificateIdentifier(string)

Verilen Key Vault Sertifika Kimliğini ayrıştırır. Bir örnek:

https://< keyvault-name.vault.azure.net/certificates/>< sertifika-adı>/<unique-version-id>

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

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

Parametreler

id

string

Key Vault Sertifikasının Kimliği.

Döndürülenler

KeyVaultCertificateIdentifier

Değişken Ayrıntıları

DefaultCertificatePolicy

DefaultCertificatePolicy, varsayılan parametreler olarak faydalı olan değerleri sertifikanın politikasını değiştiren yöntemlere dışa aktarır.

DefaultCertificatePolicy: { issuerName: string, subject: string }

Tür

{ issuerName: string, subject: string }

logger

logger: AzureLogger

Tür

AzureLogger