@azure/keyvault-certificates package

Előkelő társaság

A KeyVault-tanúsítványok funkcióval kommunikáló ügyfél

Felületek

AdministratorContact	A tanúsítványkibocsátó szervezeti rendszergazdájának adatai.
BackupCertificateResult	A biztonsági mentési tanúsítvány eredménye, amely tartalmazza a biztonsági mentési blobot.
BeginCreateCertificateOptions	A beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) számára továbbítható opcionális paramétereket képviselő felület
CertificateClientOptions	A KeyVault CertificateClient által elfogadott választható paraméterek
CertificateContactAll	A tárolótanúsítványok kapcsolattartási adatainak alakja.
CertificateIssuer	Egy kiállító tulajdonságait képviselő felület.
CertificateOperation	A rendszer egy tanúsítványműveletet aszinkron kérések esetén ad vissza.
CertificateOperationError	A Key Vault-kiszolgáló hibája.
CertificateOperationState	A CertificateOperationPoller állapotának nyilvánosan elérhető tulajdonságait képviselő felület.
CertificatePolicyProperties	A tanúsítvány szabályzatát képviselő felület (a tulajdonos tulajdonságai nélkül).
CertificatePollerOptions	A beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) és beginRecoverDeletedCertificate(string, CertificatePollerOptions) számára továbbítható opcionális paramétereket képviselő felület
CertificateProperties	Egy tanúsítvány tulajdonságait képviselő felület
CoreSubjectAlternativeNames	Egy X509-objektum tulajdonosának alternatív nevei.
CreateCertificateOptions	A <xref:createCertificate>beállításai.
CreateIssuerOptions	A createIssuer(string, string, CreateIssuerOptions)beállításai.
DeletedCertificate	Törölt tanúsítványt jelképező felület.
ErrorModel	A Key Vault-kiszolgáló hibamodellje.
ImportCertificateOptions	A importCertificate(string, Uint8Array, ImportCertificateOptions)beállításai.
IssuerAttributes	A Key Vault szolgáltatás által felügyelt kiállító attribútumai.
IssuerCredentials	A tanúsítványkibocsátóhoz használandó hitelesítő adatok.
IssuerParameters	A tanúsítvány X509-összetevőjének kiállítójának paraméterei.
IssuerProperties	Egy tanúsítványkibocsátó tulajdonságait képviselő felület
KeyVaultCertificate	Tanúsítványt a tanúsítvány szabályzata nélkül képviselő felület
KeyVaultCertificateIdentifier	A Key Vault tanúsítványazonosítóját alkotó szegmenseket jelöli.
KeyVaultCertificatePollOperationState	A Key Vault tanúsítványbeporzó műveleteinek állapotának nyilvános alakját képviselő felület.
KeyVaultCertificateWithPolicy	Egy tanúsítványt és annak szabályzatát képviselő felület
LifetimeAction	A Key Vault által a tanúsítvány élettartama alatt végrehajtandó művelet és annak eseményindítója.
ListDeletedCertificatesOptions	Az listDeletedCertificates(ListDeletedCertificatesOptions)átadott CertificateClient-lapozott műveletek opcionális paramétereit képviselő felület.
ListPropertiesOfCertificatesOptions	Az listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)átadott CertificateClient-lapozott műveletek opcionális paramétereit képviselő felület.
PolicySubjectProperties	A tanúsítvány szabályzatának lehetséges tulajdonosi tulajdonságait képviselő felület. A végső típushoz legalább egy ilyen tulajdonságnak léteznie kell.
PollerLike	A poller absztrakt ábrázolása, amelynek célja, hogy a felhasználónak csak a minimális API-t tegye elérhetővé.
PollerLikeWithCancellation	A poller absztrakt ábrázolása, amelynek célja, hogy a felhasználónak csak a minimális API-t tegye elérhetővé.
SubjectAlternativeNamesAll	A tanúsítványszabályzat tárgyát képező alternatív neveket képviselő felület.
UpdateCertificateOptions	A <xref:updateCertificate>beállításai.
UpdateIssuerOptions	A updateIssuer(string, UpdateIssuerOptions)beállításai.
X509CertificateProperties	A tanúsítvány X509 összetevőjének tulajdonságai.

Típus-aliasok

ActionType	A végrehajtandó művelet.
ArrayOneOrMore	Legalább egy tulajdonsággal rendelkező tömb.
BackupCertificateOptions	A backupCertificate(string, OperationOptions)beállításai.
BeginDeleteCertificateOptions	A beginDeleteCertificate(string, CertificatePollerOptions) számára továbbítható opcionális paramétereket képviselő felület
BeginRecoverDeletedCertificateOptions	A beginRecoverDeletedCertificate(string, CertificatePollerOptions) számára továbbítható opcionális paramétereket képviselő felület
CancelCertificateOperationOptions	A <xref:cancelCertificateOperation>beállításai.
CertificateContact	A tárolótanúsítványok kapcsolattartási adatai. Minden partnernek legalább egy tulajdonsága lesz a CertificateContactAll, azaz az e-mailCím, a név vagy a telefon.
CertificateContentType	A contentType értékeit határozza meg. Lehetséges értékek: "application/x-pem-file", "application/x-pkcs12"
CertificateKeyCurveName	Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> a JsonWebKeyCurveName használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek P-256: A NIST P-256 háromliptikus görbe, AKA SECG-görbe SECP256R1. P-384: Az NIST P-384 háromliptikus görbe, az AKA SECG-görbe SECP384R1. P-521: A NIST P-521 háromliptikus görbe, AKA SECG-görbe SECP521R1. P-256K: A SECG SECP256K1 háromliptikus görbe.
CertificateKeyType	A tanúsítványhoz használandó kulcspár típusa. <xref:KnownJsonWebKeyType> a JsonWebKeyType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek EC: Elliptikus görbe. EC-HSM: Elliptikus görbe titkos kulccsal, amely nem exportálható a HSM-ből. RSA: RSA (https://tools.ietf.org/html/rfc3447). RSA-HSM: A HSM-ből nem exportálható titkos kulccsal rendelkező RSA. okt.: Oktet sorozat (szimmetrikus kulcsok ábrázolására szolgál). okt-HSM: A HSM-ből nem exportálható titkos kulccsal rendelkező oktett-sorozat.
CertificatePolicy	Egy tanúsítvány szabályzatát képviselő típus, amely legalább egy tulajdonosi tulajdonsággal rendelkezik.
CertificatePolicyAction	A végrehajtandó művelet.
CertificateTags	A tanúsítványcímkék alakját jelképező felület. A címkék csak sztringkulcs-érték párok.
CreateCertificateState	A CreateCertificatePoller műveleti állapot nyilvános megjelenítése.
DeleteCertificateOperationOptions	A deleteCertificateOperation(string, OperationOptions)beállításai.
DeleteCertificateState	A DeleteCertificatePoller műveleti állapot nyilvános megjelenítése.
DeleteContactsOptions	A deleteContacts(OperationOptions)beállításai.
DeleteIssuerOptions	A deleteIssuer(string, OperationOptions)beállításai.
DeletionRecoveryLevel	Az aktuális tároló titkos kulcsainak jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos megőrzési időköz végén. <xref:KnownDeletionRecoveryLevel> a DeletionRecoveryLeveltel felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a törlési műveletekkel szembeni védelemnek; az adatok helyrehozhatatlanul elvesznek, ha egy törlési műveletet az entitás szintjén vagy annál magasabb szinten fogadnak el (tároló, erőforráscsoport, előfizetés stb.) Helyreállítható+Helyreállítható: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz törlésre) van lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt (90 nap), és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre Recoveryable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési idő (90 nap) alatt helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre CustomizedRecoverable+Purgeable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (azaz 7 <= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. CustomizedRecoverable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz 7 <= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és amíg az előfizetés továbbra is elérhető. CustomizedRecoverable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen, amikor 7 <= SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és azt is tükrözi, hogy maga az előfizetés nem törölhető.
GetCertificateOperationOptions	A getCertificateOperation(string, CertificatePollerOptions)beállításai.
GetCertificateOptions	A getCertificate(string, OperationOptions)beállításai.
GetCertificatePolicyOptions	A getCertificatePolicy(string, OperationOptions)beállításai.
GetCertificateVersionOptions	A getCertificateVersion(string, string, OperationOptions)beállításai.
GetContactsOptions	A getContacts(OperationOptions)beállításai.
GetDeletedCertificateOptions	A getDeletedCertificate(string, OperationOptions)beállításai.
GetIssuerOptions	A getIssuer(string, OperationOptions)beállításai.
GetPlainCertificateOperationOptions	A <xref:getPlainCertificateOperation>beállításai.
ImportCertificatePolicy	A tanúsítvány importálási szabályzatát képviselő típus, amely nem igényel SAN-t vagy tulajdonost
KVPollerLike	A Core-Lro PollerLike elavult KeyVault-példánya.
KeyUsageType	A tanúsítványkulcs támogatott használati módjai. <xref:KnownKeyUsageType> a KeyUsageType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek digitalSignature: Azt jelzi, hogy a tanúsítványkulcs használható digitális aláírásként. nem dedukálási: Azt jelzi, hogy a tanúsítványkulcs használható a hitelesítéshez. keyEncipherment: Azt jelzi, hogy a tanúsítványkulcs használható kulcstitkosításhoz. dataEncipherment: Azt jelzi, hogy a tanúsítványkulcs használható az adattitkosításhoz. keyAgreement: Azt jelzi, hogy a tanúsítványkulcs használható a kulcsszerződés meghatározására, például a Diffie-Hellman kulcsszerződés algoritmusával létrehozott kulcsra. keyCertSign: Azt jelzi, hogy a tanúsítványkulcs használható a tanúsítványok aláírására. cRLSign: Azt jelzi, hogy a tanúsítványkulcs használható a visszavont tanúsítványok listájának aláírására. encipherOnly: Azt jelzi, hogy a tanúsítványkulcs csak titkosításhoz használható. decipherOnly: Azt jelzi, hogy a tanúsítványkulcs csak visszafejtéshez használható.
ListPropertiesOfCertificateVersionsOptions	Az listPropertiesOfCertificateVersions(string, OperationOptions)átadott CertificateClient-lapozott műveletek opcionális paramétereit képviselő felület.
ListPropertiesOfIssuersOptions	Az listPropertiesOfIssuers(OperationOptions)átadott CertificateClient-lapozott műveletek opcionális paramétereit képviselő felület.
MergeCertificateOptions	A mergeCertificate(string, Uint8Array[], OperationOptions)választható paramétereit képviselő felület.
PurgeDeletedCertificateOptions	A purgeDeletedCertificate(string, OperationOptions)beállításai.
RecoverDeletedCertificateState	Elavult: Törölt tanúsítvány-lekérdezési művelet helyreállításának nyilvános képviselete
RequireAtLeastOne	A RequireAtLeastOne segít létrehozni egy olyan típust, amelyben a felület legalább egyik tulajdonsága (bármilyen tulajdonság lehet) léteznie kell. Ez a TypeScript segédprogramtípusai miatt működik: https://www.typescriptlang.org/docs/handbook/utility-types.html Vizsgáljuk meg: `[K in keyof T]-?` ez a tulajdonság (K) csak akkor érvényes, ha a neve megegyezik a T bármely tulajdonságával. `Required<Pick<T, K>>` új típust készít a T-ből az iteráció aktuális tulajdonságával, és szükség szerint megjelöli `Partial<Pick<T, Exclude<keyof T, K>>>` egy új típust hoz létre a T összes tulajdonságával, kivéve a K tulajdonságot. `&` a típust egyetlen kötelező tulajdonsággal egyesíti a `Required<...>` az `Partial<...>`összes választható tulajdonságával. `[keyof T]` biztosítja, hogy csak a T tulajdonsága engedélyezett.
RestoreCertificateBackupOptions	A restoreCertificateBackup(Uint8Array, OperationOptions)választható paramétereit képviselő felület.
SetContactsOptions	A setContacts(CertificateContact[], OperationOptions)beállításai.
SubjectAlternativeNames	A tárgytulajdonság alternatívái. Ha van ilyen, legalább a SubjectAlternativeNamesAll tulajdonság egyikével kell rendelkeznie.
UpdateCertificatePolicyOptions	A updateCertificatePolicy(string, CertificatePolicy, OperationOptions)beállításai.

Enums

KnownCertificateKeyCurveNames	A szolgáltatás által elfogadott CertificateKeyCurveName ismert értékei.
KnownCertificateKeyTypes	A szolgáltatás által elfogadott CertificateKeyType ismert értékei.
KnownDeletionRecoveryLevels	Az aktuális tároló titkos kulcsainak jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos megőrzési időköz végén.
KnownKeyUsageTypes	A szolgáltatás által elfogadott KeyUsageType ismert értékei.
WellKnownIssuer	Jól ismert kiállítók az alapértelmezett beállításhoz

Functions

parseKeyVaultCertificateIdentifier(string)

Elemzi a megadott Key Vault-tanúsítványazonosítót. Ilyen például a következő:

https://< keyvault-name.vault.azure.net/certificates/>< tanúsítványnév>/<egyedi-verzió-azonosító>

A fenti azonosító elemzésekor a függvény a következőt adja vissza:

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

Változók

DefaultCertificatePolicy	A DefaultCertificatePolicy alapértelmezett paraméterként hasznos értékeket exportál olyan metódusokba, amelyek módosítják a tanúsítvány szabályzatát.
logger	A @azure/logger csomag konfigurációja.

Funkciók részletei

parseKeyVaultCertificateIdentifier(string)

Elemzi a megadott Key Vault-tanúsítványazonosítót. Ilyen például a következő:

https://< keyvault-name.vault.azure.net/certificates/>< tanúsítványnév>/<egyedi-verzió-azonosító>

A fenti azonosító elemzésekor a függvény a következőt adja vissza:

  {
     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

Paraméterek

id: string

A Key Vault-tanúsítvány azonosítója.

Visszatér

KeyVaultCertificateIdentifier

Variable Details

DefaultCertificatePolicy

A DefaultCertificatePolicy alapértelmezett paraméterként hasznos értékeket exportál olyan metódusokba, amelyek módosítják a tanúsítvány szabályzatát.

DefaultCertificatePolicy: { issuerName: string, subject: string }

Típus

{ issuerName: string, subject: string }

logger

A @azure/logger csomag konfigurációja.

logger: AzureLogger

Típus

AzureLogger

Megosztás a következőn keresztül:

@azure/keyvault-certificates package

Előkelő társaság

Felületek

Típus-aliasok

A szolgáltatás által támogatott ismert értékek

A szolgáltatás által támogatott ismert értékek

A szolgáltatás által támogatott ismert értékek

A szolgáltatás által támogatott ismert értékek

Enums

Functions

Változók

Funkciók részletei

parseKeyVaultCertificateIdentifier(string)

Paraméterek

Visszatér

Variable Details

DefaultCertificatePolicy

Típus

logger

Típus