Aracılığıyla paylaş


@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

geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

CertificateClientOptions

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

CertificateContactAll

Kasa sertifikaları için kişi bilgilerinin şekli.

CertificateIssuer

Verenin özelliklerini temsil eden bir 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

ve'ye beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)beginDeleteCertificate(string, CertificatePollerOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirimbeginRecoverDeletedCertificate(string, CertificatePollerOptions)

CertificateProperties

Sertifikanın özelliklerini temsil eden arabirim

CoreSubjectAlternativeNames

X509 nesnesinin konu alternatif adları.

CreateCertificateOptions

için <xref:createCertificate>seçenekler.

CreateIssuerOptions

için createIssuer(string, string, CreateIssuerOptions)seçenekler.

DeletedCertificate

Silinen sertifikayı temsil eden bir arabirim.

ErrorModel

Anahtar kasası sunucusu hata modeli.

ImportCertificateOptions

için importCertificate(string, Uint8Array, ImportCertificateOptions)seçenekler.

IssuerAttributes

Key Vault hizmeti tarafından yönetilen bir verenin öznitelikleri.

IssuerCredentials

Sertifika 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 oluşturan segmentleri temsil eder.

KeyVaultCertificatePollOperationState

Key Vault Sertifikası Poller'ın işlemlerinin durumunun genel şeklini temsil eden arabirim.

KeyVaultCertificateWithPolicy

İlkesine sahip bir sertifikayı temsil eden arabirim

LifetimeAction

Bir sertifikanın ömrü boyunca Key Vault tarafından gerçekleştirilecek eylem ve tetikleyicisi.

ListDeletedCertificatesOptions

öğesine geçirilen listDeletedCertificates(ListDeletedCertificatesOptions)CertificateClient disk belleğine alınan işlemler için isteğe bağlı parametreleri temsil eden bir arabirim.

ListPropertiesOfCertificatesOptions

öğesine geçirilen listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)CertificateClient disk belleğine alınan işlemler 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 amacıyla bir poller'in soyut gösterimi.

SubjectAlternativeNamesAll

Sertifika ilkesinin konusunun alternatif adlarını temsil eden arabirim.

UpdateCertificateOptions

için <xref:updateCertificate>seçenekler.

UpdateIssuerOptions

için updateIssuer(string, UpdateIssuerOptions)seçenekler.

X509CertificateProperties

Bir sertifikanın X509 bileşeninin özellikleri.

Tür Diğer Adları

ActionType

ActionType değerlerini tanımlar.

ArrayOneOrMore

En az bir özelliği olan bir dizi.

BackupCertificateOptions

için backupCertificate(string, OperationOptions)seçenekler.

BeginDeleteCertificateOptions

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

BeginRecoverDeletedCertificateOptions

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

CancelCertificateOperationOptions

için <xref:cancelCertificateOperation>seçenekler.

CertificateContact

Kasa sertifikaları için iletişim bilgileri. Her kişi CertificateContactAll'ın ö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

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
P-384
P-521
P-256K

CertificateKeyType

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
EC-HSM
RSA
RSA-HSM
Ekim
oct-HSM

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

için deleteCertificateOperation(string, OperationOptions)seçenekler.

DeleteCertificateState

DeleteCertificatePoller işlem durumunun genel gösterimi.

DeleteContactsOptions

için deleteContacts(OperationOptions)seçenekler.

DeleteIssuerOptions

için deleteIssuer(string, OperationOptions)seçenekler.

DeletionRecoveryLevel

DeletionRecoveryLevel değerlerini tanımlar.
<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 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.

GetCertificateOperationOptions

için getCertificateOperation(string, CertificatePollerOptions)seçenekler.

GetCertificateOptions

için getCertificate(string, OperationOptions)seçenekler.

GetCertificatePolicyOptions

için getCertificatePolicy(string, OperationOptions)seçenekler.

GetCertificateVersionOptions

için getCertificateVersion(string, string, OperationOptions)seçenekler.

GetContactsOptions

için getContacts(OperationOptions)seçenekler.

GetDeletedCertificateOptions

için getDeletedCertificate(string, OperationOptions)seçenekler.

GetIssuerOptions

için getIssuer(string, OperationOptions)seçenekler.

GetPlainCertificateOperationOptions

için <xref:getPlainCertificateOperation>seçenekler.

ImportCertificatePolicy

Sertifikanın içeri aktarma ilkesini temsil eden ve SAN veya Konu gerektirmeyen bir tür

KVPollerLike

Core-lro'nun PollerLike'inin KeyVault kopyası kullanım dışı bırakıldı.

KeyUsageType

KeyUsageType değerlerini tanı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
Inkar
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly

ListPropertiesOfCertificateVersionsOptions

öğesine geçirilen listPropertiesOfCertificateVersions(string, OperationOptions)CertificateClient disk belleğine alınan işlemler için isteğe bağlı parametreleri temsil eden bir arabirim.

ListPropertiesOfIssuersOptions

öğesine geçirilen listPropertiesOfIssuers(OperationOptions)CertificateClient disk belleğine alınan işlemler için isteğe bağlı parametreleri temsil eden bir arabirim.

MergeCertificateOptions

için mergeCertificate(string, Uint8Array[], OperationOptions)isteğe bağlı parametreleri temsil eden bir arabirim.

PurgeDeletedCertificateOptions

için purgeDeletedCertificate(string, OperationOptions)seçenekler.

RecoverDeletedCertificateState

Kullanım dışı: Silinen sertifika yoklama işleminin kurtarılmasının genel gösterimi

RequireAtLeastOne

RequireAtLeastOne, bir arabirimin özelliklerinden en az birinin (herhangi bir özellik olabilir) bulunması gereken bir tür oluşturulmasına yardımcı olur.

TypeScript'in yardımcı program türleri nedeniyle bu işe yarar: 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ü, 'den Required<...> gelen tüm isteğe bağlı özelliklerle birlikte yalnızca bir gerekli özelliğiyle birleştiren şeydir Partial<...>.
  • [keyof T] yalnızca T özelliklerine izin verildiğinden emin olur.
RestoreCertificateBackupOptions

için restoreCertificateBackup(Uint8Array, OperationOptions)isteğe bağlı parametreleri temsil eden bir arabirim.

SetContactsOptions

için setContacts(CertificateContact[], OperationOptions)seçenekler.

SubjectAlternativeNames

Konu özelliğinin alternatifleri. Varsa, subjectAlternativeNamesAll özelliklerinden en az birine sahip olmalıdır.

UpdateCertificatePolicyOptions

için updateCertificatePolicy(string, CertificatePolicy, OperationOptions)seçenekler.

Numaralandırmalar

KnownCertificateKeyCurveNames

Hizmet tarafından kabul edilen CertificateKeyCurveName'in bilinen değerleri.

KnownCertificateKeyTypes

Hizmet tarafından kabul edilen CertificateKeyType'ın bilinen değerleri.

KnownDeletionRecoveryLevels

Hizmetin kabul ettiğini Bilinen DeletionRecoveryLevel değerleri.

KnownKeyUsageTypes

Hizmetin kabul ettiğini bilinen KeyUsageType değerleri.

WellKnownIssuer

Varsayılanı seçmek için iyi bilinen verenler

İşlevler

parseKeyVaultCertificateIdentifier(string)

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

https://.vault.azure.net/certificates//

Yukarıdaki kimliği ayrıştırırken bu işlev şunu 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>"
  }

İşlev Ayrıntıları

parseKeyVaultCertificateIdentifier(string)

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

https://.vault.azure.net/certificates//

Yukarıdaki kimliği ayrıştırırken bu işlev şunu 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