Partager via


@azure/keyvault-certificates package

Classes

CertificateClient

Client à interagir avec la fonctionnalité de certificats KeyVault

Interfaces

AdministratorContact

Détails de l’administrateur de l’organisation de l’émetteur du certificat.

BackupCertificateResult

Résultat du certificat de sauvegarde, contenant l’objet blob de sauvegarde.

BeginCreateCertificateOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

CertificateClientOptions

Paramètres facultatifs acceptés par le CertificateClient de KeyVault

CertificateContactAll

Forme des informations de contact pour les certificats de coffre.

CertificateIssuer

Interface représentant les propriétés d’un émetteur.

CertificateOperation

Une opération de certificat est retournée en cas de demandes asynchrones.

CertificateOperationError

Erreur du serveur du coffre de clés.

CertificateOperationState

Interface représentant les propriétés publiquement disponibles de l’état du CertificateOperationPoller.

CertificatePolicyProperties

Interface représentant la stratégie d’un certificat (sans les propriétés de l’objet).

CertificatePollerOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) et beginRecoverDeletedCertificate(string, CertificatePollerOptions)

CertificateProperties

Interface représentant les propriétés d’un certificat

CoreSubjectAlternativeNames

Autres noms d’objet d’un objet X509.

CreateCertificateOptions

Options pour <xref:createCertificate>.

CreateIssuerOptions

Options pour createIssuer(string, string, CreateIssuerOptions).

DeletedCertificate

Interface représentant un certificat supprimé.

ErrorModel

Modèle d’erreur du serveur de coffre de clés.

ImportCertificateOptions

Options pour importCertificate(string, Uint8Array, ImportCertificateOptions).

IssuerAttributes

Attributs d’un émetteur géré par le service Key Vault.

IssuerCredentials

Informations d’identification à utiliser pour l’émetteur du certificat.

IssuerParameters

Paramètres pour l’émetteur du composant X509 d’un certificat.

IssuerProperties

Interface représentant les propriétés d’un émetteur de certificat

KeyVaultCertificate

Interface représentant un certificat sans stratégie du certificat

KeyVaultCertificateIdentifier

Représente les segments qui composent un ID de certificat Key Vault.

KeyVaultCertificatePollOperationState

Interface représentant la forme publique de l’état d’un Key Vault opérations de Certificate Poller.

KeyVaultCertificateWithPolicy

Interface représentant un certificat avec sa stratégie

LifetimeAction

Action et son déclencheur qui seront exécutés par Key Vault sur la durée de vie d’un certificat.

ListDeletedCertificatesOptions

Interface représentant des paramètres facultatifs pour les opérations paginées CertificateClient passées à listDeletedCertificates(ListDeletedCertificatesOptions).

ListPropertiesOfCertificatesOptions

Interface représentant des paramètres facultatifs pour les opérations paginées CertificateClient passées à listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).

PolicySubjectProperties

Interface représentant les propriétés d’objet possibles de la stratégie d’un certificat. Le type final nécessite l’existence d’au moins une de ces propriétés.

PollerLike

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.

SubjectAlternativeNamesAll

Interface représentant les noms alternatifs de l’objet d’une stratégie de certificat.

UpdateCertificateOptions

Options pour <xref:updateCertificate>.

UpdateIssuerOptions

Options pour updateIssuer(string, UpdateIssuerOptions).

X509CertificateProperties

Propriétés du composant X509 d’un certificat.

Alias de type

ActionType

Définit des valeurs pour ActionType.

ArrayOneOrMore

Tableau avec une propriété au minimum.

BackupCertificateOptions

Options pour backupCertificate(string, OperationOptions).

BeginDeleteCertificateOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteCertificate(string, CertificatePollerOptions)

BeginRecoverDeletedCertificateOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginRecoverDeletedCertificate(string, CertificatePollerOptions)

CancelCertificateOperationOptions

Options pour <xref:cancelCertificateOperation>.

CertificateContact

Informations de contact pour les certificats de coffre. Chaque contact aura au moins une des propriétés de CertificateContactAll, qui sont : emailAddress, name ou phone.

CertificateContentType

Définit des valeurs pour contentType. Les valeurs possibles sont les suivantes : 'application/x-pem-file', 'application/x-pkcs12'

CertificateKeyCurveName

Définit des valeurs pour JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> peut être utilisé indifféremment avec JsonWebKeyCurveName, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

P-256
P-384
P-521
P-256K

CertificateKeyType

Définit des valeurs pour JsonWebKeyType.
<xref:KnownJsonWebKeyType> peut être utilisé indifféremment avec JsonWebKeyType. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

CertificatePolicy

Type représentant la stratégie d’un certificat avec au moins une des propriétés d’objet.

CertificatePolicyAction

Action qui sera exécutée.

CertificateTags

Interface représentant la forme des balises de certificat. Les balises ne sont que des paires clé-valeur de chaîne.

CreateCertificateState

Représentation publique de l’état de l’opération CreateCertificatePoller.

DeleteCertificateOperationOptions

Options pour deleteCertificateOperation(string, OperationOptions).

DeleteCertificateState

Représentation publique de l’état de l’opération DeleteCertificatePoller.

DeleteContactsOptions

Options pour deleteContacts(OperationOptions).

DeleteIssuerOptions

Options pour deleteIssuer(string, OperationOptions).

DeletionRecoveryLevel

Définit des valeurs pour DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> peut être utilisé indifféremment avec SuppressionRecoveryLevel, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Purgeable : désigne un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération de suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération de suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Récupérable+Purgeable : désigne un état de coffre dans lequel la suppression est récupérable et qui permet également une suppression immédiate et définitive (par exemple, purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de purge est demandée ou si l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Récupérable : désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Récupérable+ProtectedSubscription : désigne un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et permanente (c’est-à-dire la purge) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
CustomizedRecoverable+Purgeable : désigne un état de coffre dans lequel la suppression est récupérable et qui permet également une suppression immédiate et définitive (c’est-à-dire, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de purge est demandée ou si l’abonnement est annulé.
CustomRecoverable : désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription : désigne un coffre et un état d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et permanente (c’est-à-dire la purge) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement quand 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.

GetCertificateOperationOptions

Options pour getCertificateOperation(string, CertificatePollerOptions).

GetCertificateOptions

Options pour getCertificate(string, OperationOptions).

GetCertificatePolicyOptions

Options pour getCertificatePolicy(string, OperationOptions).

GetCertificateVersionOptions

Options pour getCertificateVersion(string, string, OperationOptions).

GetContactsOptions

Options pour getContacts(OperationOptions).

GetDeletedCertificateOptions

Options pour getDeletedCertificate(string, OperationOptions).

GetIssuerOptions

Options pour getIssuer(string, OperationOptions).

GetPlainCertificateOperationOptions

Options pour <xref:getPlainCertificateOperation>.

ImportCertificatePolicy

Type représentant la stratégie d’importation d’un certificat qui ne nécessite pas de SAN ou d’objet

KVPollerLike

Copie dépréciée de KeyVault du PollerLike de core-lro.

KeyUsageType

Définit des valeurs pour KeyUsageType.
<xref:KnownKeyUsageType> peut être utilisé indifféremment avec KeyUsageType. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly

ListPropertiesOfCertificateVersionsOptions

Interface représentant des paramètres facultatifs pour les opérations paginées CertificateClient passées à listPropertiesOfCertificateVersions(string, OperationOptions).

ListPropertiesOfIssuersOptions

Interface représentant des paramètres facultatifs pour les opérations paginées CertificateClient passées à listPropertiesOfIssuers(OperationOptions).

MergeCertificateOptions

Interface représentant des paramètres facultatifs pour mergeCertificate(string, Uint8Array[], OperationOptions).

PurgeDeletedCertificateOptions

Options pour purgeDeletedCertificate(string, OperationOptions).

RecoverDeletedCertificateState

Déconseillé : représentation publique de la récupération d’une opération d’interrogation de certificat supprimée

RequireAtLeastOne

RequireAtLeastOne permet de créer un type dans lequel au moins une des propriétés d’une interface (peut être n’importe quelle propriété) doit exister.

Cela fonctionne en raison des types d’utilitaires de TypeScript : https://www.typescriptlang.org/docs/handbook/utility-types.html examinons-le :

  • [K in keyof T]-? cette propriété (K) est valide uniquement si elle a le même nom que toute propriété de T.
  • Required<Pick<T, K>> crée un nouveau type à partir de T avec uniquement la propriété actuelle dans l’itération et le marque comme requis
  • Partial<Pick<T, Exclude<keyof T, K>>> crée un nouveau type avec toutes les propriétés de T, à l’exception de la propriété K.
  • & est ce qui unit le type avec une seule propriété requise à partir de Required<...> avec toutes les propriétés facultatives de Partial<...>.
  • [keyof T] garantit que seules les propriétés de T sont autorisées.
RestoreCertificateBackupOptions

Interface représentant des paramètres facultatifs pour restoreCertificateBackup(Uint8Array, OperationOptions).

SetContactsOptions

Options pour setContacts(CertificateContact[], OperationOptions).

SubjectAlternativeNames

Alternatives à la propriété subject. S’il est présent, il doit avoir au moins l’une des propriétés de SubjectAlternativeNamesAll.

UpdateCertificatePolicyOptions

Options pour updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Énumérations

KnownCertificateKeyCurveNames

Valeurs connues de CertificateKeyCurveName que le service accepte.

KnownCertificateKeyTypes

Valeurs connues de CertificateKeyType que le service accepte.

KnownDeletionRecoveryLevels

Valeurs connues de DeletionRecoveryLevel que le service accepte.

KnownKeyUsageTypes

Valeurs connues de KeyUsageType que le service accepte.

WellKnownIssuer

Émetteurs connus pour le choix d’une valeur par défaut

Fonctions

parseKeyVaultCertificateIdentifier(string)

Analyse l’ID de certificat Key Vault donné. Voici un exemple :

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

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

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

Informations relatives à la fonction

parseKeyVaultCertificateIdentifier(string)

Analyse l’ID de certificat Key Vault donné. Voici un exemple :

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

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

  {
     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ètres

id

string

ID du certificat Key Vault.

Retours