@azure/keyvault-certificates package

Referencia

Osztályok

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

Interfészek

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	Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
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 ad vissza aszinkron kérések esetén.
CertificateOperationError	A Key Vault-kiszolgáló hibája.
CertificateOperationState	A CertificateOperationPoller állapotának nyilvánosan elérhető tulajdonságait képviselő felület.
CertificatePolicyProperties	Egy tanúsítvány szabályzatát képviselő felület (a tulajdonos tulajdonságai nélkül).
CertificatePollerOptions	Egy interfész, amely az opcionális paramétereket jelöli, amelyek átadhatók a következőnek: beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) és beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	Egy tanúsítvány tulajdonságait képviselő felület
CoreSubjectAlternativeNames	Egy X509-objektum tulajdonosának alternatív nevei.
CreateCertificateOptions	A beállítások a következőhöz: <xref:createCertificate>.
CreateIssuerOptions	A beállítások a következőhöz: createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	Törölt tanúsítványt jelképező felület.
ErrorModel	A Key Vault-kiszolgáló hibamodellje.
ImportCertificateOptions	A beállítások a következőhöz: importCertificate(string, Uint8Array, ImportCertificateOptions).
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 képviselő felület a tanúsítvány szabályzata nélkül
KeyVaultCertificateIdentifier	Azokat a szegmenseket jelöli, amelyek Key Vault tanúsítványazonosítót írnak.
KeyVaultCertificatePollOperationState	Egy olyan felület, amely egy Key Vault Tanúsítvány-választó műveleteinek állapotának nyilvános alakját jelképezi.
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 során végrehajtandó művelet és annak eseményindítója.
ListDeletedCertificatesOptions	A certificateClient lapozóműveletek opcionális paramétereit jelölő felület, amely a következőnek lett átadva listDeletedCertificates(ListDeletedCertificatesOptions): .
ListPropertiesOfCertificatesOptions	A certificateClient lapozóműveletek opcionális paramétereit jelölő felület, amely a következőnek lett átadva listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions): .
PolicySubjectProperties	A tanúsítványházirend lehetséges tulajdonosi tulajdonságait jelölő felület. A végső típushoz legalább az egyik tulajdonságnak léteznie kell.
PollerLike	A poller absztrakt ábrázolása, amely csak a felhasználó által igényelt minimális API-t teszi elérhetővé.
SubjectAlternativeNamesAll	A tanúsítványszabályzat tulajdonosának alternatív neveit jelölő felület.
UpdateCertificateOptions	Beállítások a következőhöz: <xref:updateCertificate>.
UpdateIssuerOptions	Beállítások a következőhöz: updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	A tanúsítvány X509 összetevőjének tulajdonságai.

Típusaliasok

ActionType	Az ActionType értékeit határozza meg.
ArrayOneOrMore	Legalább egy tulajdonsággal rendelkező tömb.
BackupCertificateOptions	A beállítások a következőhöz: backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions	Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	A beállítások a következőhöz: <xref:cancelCertificateOperation>.
CertificateContact	A tárolótanúsítványok kapcsolattartási adatai. Minden partnernek legalább egy tulajdonsága lesz a CertificateContactAll, amelyek a következők: e-mailAddress, név vagy telefon.
CertificateContentType	A contentType értékeit határozza meg. Lehetséges értékek: "application/x-pem-file", "application/x-pkcs12"
CertificateKeyCurveName	A JsonWebKeyCurveName értékeit határozza meg. <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 P-384 P-521 P-256K
CertificateKeyType	A JsonWebKeyType értékeit határozza meg. <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 EC-HSM RSA RSA-HSM Október okt-HSM
CertificatePolicy	Egy tanúsítványházirendet 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űveletállapot nyilvános megjelenítése.
DeleteCertificateOperationOptions	A beállítások a következőhöz: deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	A DeleteCertificatePoller műveletállapot nyilvános megjelenítése.
DeleteContactsOptions	A beállítások a következőhöz: deleteContacts(OperationOptions).
DeleteIssuerOptions	A beállítások a következőhöz: deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	A DeletionRecoveryLevel értékeit határozza meg. <xref:KnownDeletionRecoveryLevel> a DeletionRecoveryLevel 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 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és művelet elleni védelemnek; az adatok helyrehozhatatlanul elvesznek egy törlési művelet entitásszinten vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) elfogadásakor. Helyreállítható+Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a végleges 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 elteltével 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 végleges 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őköz (90 nap) során, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap elteltével 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 helyreállítható megőrzési időtartamon belül (90 nap), az azonnali és végleges törlés (azaz végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen. A rendszer 90 nap elteltével 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 a törlést, 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őköz alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. CustomizedRecoverable: 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 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őköz 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 végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le 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őköz alatt, és azt is tükrözi, hogy maga az előfizetés nem mondható le.
GetCertificateOperationOptions	A beállítások a következőhöz: getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	A beállítások a következőhöz: getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	A beállítások a következőhöz: getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	A beállítások a következőhöz: getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	A beállítások a következőhöz: getContacts(OperationOptions).
GetDeletedCertificateOptions	A beállítások a következőhöz: getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	A beállítások a következőhöz: getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	A beállítások a következőhöz: <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	A tanúsítvány importálási szabályzatát képviselő típus, amelyhez nincs szükség san vagy tulajdonosra
KVPollerLike	A core-lro PollerLike elavult KeyVault-példánya.
KeyUsageType	A KeyUsageType értékeit határozza meg. <xref:KnownKeyUsageType> a KeyUsageType-tal 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 nonRepudiation keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	A certificateClient lapozóműveletek opcionális paramétereit jelölő felület, amely a következőnek lett átadva listPropertiesOfCertificateVersions(string, OperationOptions): .
ListPropertiesOfIssuersOptions	A certificateClient lapozóműveletek opcionális paramétereit jelölő felület, amely a következőnek lett átadva listPropertiesOfIssuers(OperationOptions): .
MergeCertificateOptions	A választható paramétereket jelölő felület.mergeCertificate(string, Uint8Array[], OperationOptions)
PurgeDeletedCertificateOptions	Beállítások a következőhöz: purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	Elavult: Törölt tanúsítvány-lekérdezési művelet helyreállításának nyilvános reprezentációja
RequireAtLeastOne	A RequireAtLeastOne segítségével olyan típust hozhat létre, amelyben egy interfész (bármely tulajdonság) legalább egy tulajdonságának 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 ugyanazzal a névvel rendelkezik, mint a T bármely tulajdonsága. `Required<Pick<T, K>>` új típust hoz létre a T-ből az iteráció aktuális tulajdonságával, és kötelezőként jelöli meg `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. `&` az az, amely egyetlen kötelező tulajdonsággal `Required<...>` egyesíti a típust a típus összes választható tulajdonságával `Partial<...>`. `[keyof T]` biztosítja, hogy csak a T tulajdonságai legyenek engedélyezve.
RestoreCertificateBackupOptions	A választható paramétereket jelölő felület.restoreCertificateBackup(Uint8Array, OperationOptions)
SetContactsOptions	Beállítások a következőhöz: setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	A tárgy tulajdonság alternatívái. Ha van ilyen, legalább a SubjectAlternativeNamesAll tulajdonság egyikével kell rendelkeznie.
UpdateCertificatePolicyOptions	Beállítások a következőhöz: updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Enumerációk

KnownCertificateKeyCurveNames	A szolgáltatás által elfogadott CertificateKeyCurveName ismert értékei.
KnownCertificateKeyTypes	A szolgáltatás által elfogadott CertificateKeyType ismert értékei.
KnownDeletionRecoveryLevels	A szolgáltatás által elfogadott DeletionRecoveryLevel ismert értékei.
KnownKeyUsageTypes	A szolgáltatás által elfogadott KeyUsageType ismert értékei.
WellKnownIssuer	Jól ismert kibocsátók az alapértelmezett beállításhoz

Függvények

parseKeyVaultCertificateIdentifier(string)

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

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

A fenti azonosító elemzésekor a függvény a következőket 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>"
  }

Függvény adatai

parseKeyVaultCertificateIdentifier(string)

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

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

A fenti azonosító elemzésekor a függvény a következőket 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.

Válaszok

KeyVaultCertificateIdentifier

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

@azure/keyvault-certificates package

Osztályok

Interfészek

Típusaliasok

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

Enumerációk

Függvények

Függvény adatai

parseKeyVaultCertificateIdentifier(string)

Paraméterek

Válaszok

További források