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

<xref:beginCreateCertificate> geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CertificateClientOptions

KeyVault'un KeyClient 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

<xref:beginCreateCertificate>, <xref:beginDeleteCertificate> ve <xref:beginRecoverDeletedCertificate> 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

<xref:createIssuer>seçenekleri.
DeletedCertificate

Silinen sertifikayı temsil eden arabirim.
ErrorModel

Anahtar kasası sunucusu hata modeli.
ImportCertificateOptions

<xref:importCertificate>seçenekleri.
IssuerAttributes

Key Vault hizmeti tarafından yönetilen bir verenin öznitelikleri.
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 oluşturan kesimleri temsil eder.
KeyVaultCertificatePollOperationState

Anahtar Kasası Sertifikası Poller'ın işlemlerinin durumunun genel şeklini temsil eden arabirim.
KeyVaultCertificateWithPolicy

İlkesine sahip bir sertifikayı temsil eden arabirim
LifetimeAction

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

<xref:listDeletedCertificates>'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
ListPropertiesOfCertificatesOptions

<xref:listPropertiesOfCertificates>'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.
SubjectAlternativeNamesAll

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

<xref:updateCertificate>seçenekleri.
UpdateIssuerOptions

<xref:updateIssuer>seçenekleri.
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

<xref:backupCertificate>seçenekleri.
BeginDeleteCertificateOptions

<xref:beginDeleteCertificate> geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
BeginRecoverDeletedCertificateOptions

<xref:beginRecoverDeletedCertificate> 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

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 değerleri bil

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 değerleri bil

EC
EC-HSM
RSA
RSA-HSM
ekim
sekizli 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

<xref:deleteCertificateOperation>seçenekleri.
DeleteCertificateState

DeleteCertificatePoller işlem durumunun genel gösterimi.
DeleteContactsOptions

<xref:deleteContacts>seçenekleri.
DeleteIssuerOptions

<xref:deleteIssuer>seçenekleri.
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 değerleri bil

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) boyunca 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: 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). 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 durumda olduğunu 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: Silme işleminin kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve 7<= SoftDeleteRetentionInDays < 90 olduğunda 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

<xref:getCertificateOperation>seçenekleri.
GetCertificateOptions

<xref:getCertificate>seçenekleri.
GetCertificatePolicyOptions

<xref:getCertificatePolicy>seçenekleri.
GetCertificateVersionOptions

<xref:getCertificateVersion>seçenekleri.
GetContactsOptions

<xref:getContacts>seçenekleri.
GetDeletedCertificateOptions

<xref:getDeletedCertificate>seçenekleri.
GetIssuerOptions

<xref:getIssuer>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

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 değerleri bil

digitalSignature

keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly
ListPropertiesOfCertificateVersionsOptions

<xref:listPropertiesOfCertificateVersions>'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
ListPropertiesOfIssuersOptions

<xref:listPropertiesOfIssuers>'a geçirilen CertificateClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
MergeCertificateOptions

<xref:mergeCertificate>için isteğe bağlı parametreleri temsil eden bir arabirim.
PurgeDeletedCertificateOptions

<xref:purgeDeletedCertificate>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

<xref:restoreCertificateBackup>için isteğe bağlı parametreleri temsil eden bir arabirim.
SetContactsOptions

<xref:setContacts>seçenekleri.
SubjectAlternativeNames

Konu özelliğine alternatifler. Varsa, SubjectAlternativeNamesAll özelliklerinden en az birine sahip olmalıdır.
UpdateCertificatePolicyOptions

<xref:updateCertificatePolicy>seçenekleri.

Numaralandırmalar

KnownCertificateKeyCurveNames

Hizmetin kabul <xref:JsonWebKeyCurveName> bilinen değerleri.
KnownCertificateKeyTypes

Hizmetin kabul <xref:JsonWebKeyType> bilinen değerleri.
KnownDeletionRecoveryLevels

Hizmetin kabul <xref:DeletionRecoveryLevel> bilinen değerleri.
KnownKeyUsageTypes

Hizmetin kabul <xref:KeyUsageType> 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/>< certificate-name>/<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>"
  }

İş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/>< certificate-name>/<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)

Parametreler

id

string

Key Vault Sertifikasının kimliği.

Döndürülenler

KeyVaultCertificateIdentifier