@azure/keyvault-certificates package

Classes

Client à interagir avec la fonctionnalité de certificats KeyVault

Interfaces

AdministratorContact	Détails de l’administrateur de l’organisation de l’émetteur de 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 CertificateClient du Coffre de clés
CertificateContactAll	Forme des informations de contact pour les certificats du coffre.
CertificateIssuer	Interface représentant les propriétés d’un émetteur.
CertificateOperation	Une opération de certificat est retournée en cas de requêtes asynchrones.
CertificateOperationError	Erreur du serveur key vault.
CertificateOperationState	Interface représentant les propriétés publiquement disponibles de l’état de 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 de <xref:createCertificate>.
CreateIssuerOptions	Options de createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	Interface représentant un certificat supprimé.
ErrorModel	Modèle d’erreur du serveur key vault.
ImportCertificateOptions	Options de importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes	Les attributs d’un émetteur géré par le service Key Vault.
IssuerCredentials	Informations d’identification à utiliser pour l’émetteur de certificat.
IssuerParameters	Paramètres de 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 la stratégie du certificat
KeyVaultCertificateIdentifier	Représente les segments qui composent un identifiant de certificat Key Vault.
KeyVaultCertificatePollOperationState	Une interface représentant la forme publique de l'état des opérations d'un sondeur de certificats Key Vault.
KeyVaultCertificateWithPolicy	Interface représentant un certificat avec sa stratégie
LifetimeAction	Action et son déclencheur qui seront effectués par Key Vault sur toute 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 au moins l’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.
PollerLikeWithCancellation	Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.
SubjectAlternativeNamesAll	Interface représentant les autres noms de l’objet d’une stratégie de certificat.
UpdateCertificateOptions	Options de <xref:updateCertificate>.
UpdateIssuerOptions	Options de updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	Propriétés du composant X509 d’un certificat.

Alias de type

ActionType	Action qui sera exécutée.
ArrayOneOrMore	Tableau avec une propriété au minimum.
BackupCertificateOptions	Options de 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 de <xref:cancelCertificateOperation>.
CertificateContact	Informations de contact pour les certificats du coffre. Chaque contact aura au moins l’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	Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> pouvez être utilisé de manière interchangeable 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: courbe elliptique NIST P-256, courbe AKA SCG SECP256R1. P-384: courbe elliptique NIST P-384, courbe AKA SCG SECP384R1. P-521: courbe elliptique NIST P-521, courbe AKA SCG SECP521R1. P-256K : la courbe elliptique SECP256K1 SCG.
CertificateKeyType	Type de paire de clés à utiliser pour le certificat. <xref:KnownJsonWebKeyType> pouvez être utilisé de manière interchangeable avec JsonWebKeyType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service EC: courbe elliptique. EC-HSM: courbe elliptique avec une clé privée qui n’est pas exportable à partir du HSM. RSA : RSA (https://tools.ietf.org/html/rfc3447). RSA-HSM: RSA avec une clé privée qui n’est pas exportable à partir du HSM. oct: séquence d’octets (utilisée pour représenter des clés symétriques). oct-HSM: séquence d’octets avec une clé privée qui n’est pas exportable à partir du HSM.
CertificatePolicy	Type représentant la stratégie d’un certificat avec au moins une des propriétés de l’objet.
CertificatePolicyAction	Action qui sera exécutée.
CertificateTags	Interface représentant la forme des étiquettes de certificat. Les balises sont simplement des paires clé-valeur de chaîne.
CreateCertificateState	Représentation publique de l’état de l’opération CreateCertificatePoller.
DeleteCertificateOperationOptions	Options de deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	Représentation publique de l’état de l’opération DeleteCertificatePoller.
DeleteContactsOptions	Options de deleteContacts(OperationOptions).
DeleteIssuerOptions	Options de deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention. <xref:KnownDeletionRecoveryLevel> pouvez être utilisé de manière interchangeable avec DeletionRecoveryLevel, 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 irréversible, sans possibilité de récupération. Ce niveau correspond à aucune protection disponible contre une opération De suppression ; les données sont irrécupérablement perdues lors de l’acceptation d’une opération Delete au niveau de l’entité ou supérieure (coffre, groupe de ressources, abonnement, etc.) récupérable+purgeable: indique 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). 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 vidage est demandée ou si l’abonnement est annulé. Le système le supprime 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 purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré récupérable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée, et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré CustomRecoverable+Purgeable: indique 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 lorsque 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 vidage est demandée ou si l’abonnement est annulé. CustomRecoverable: indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant la disponibilité de l’abonnement. CustomRecoverable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable, immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement lorsque 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 de getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	Options de getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	Options de getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	Options de getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	Options de getContacts(OperationOptions).
GetDeletedCertificateOptions	Options de getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	Options de getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	Options de <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	Type représentant la stratégie d’un certificat pour l’importation qui ne nécessite pas un SAN ou un objet
KVPollerLike	Copie de KeyVault déconseillée de PollerLike de core-lro.
KeyUsageType	Utilisations prises en charge d’une clé de certificat. <xref:KnownKeyUsageType> pouvez être utilisé de manière interchangeable avec KeyUsageType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service digitalSignature: indique que la clé de certificat peut être utilisée comme signature numérique. non répudiation : indique que la clé de certificat peut être utilisée pour l’authentification. keyEncipherment: indique que la clé de certificat peut être utilisée pour le chiffrement de clé. dataEncipherment: indique que la clé de certificat peut être utilisée pour le chiffrement des données. keyAgreement: indique que la clé de certificat peut être utilisée pour déterminer le contrat de clé, tel qu’une clé créée à l’aide de l’algorithme de contrat de clé Diffie-Hellman. keyCertSign: indique que la clé de certificat peut être utilisée pour signer des certificats. cRLSign: indique que la clé de certificat peut être utilisée pour signer une liste de révocation de certificats. encipherOnly: indique que la clé de certificat peut être utilisée uniquement pour le chiffrement. déchiffrementOnly: indique que la clé de certificat peut être utilisée uniquement pour le déchiffrement.
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 de purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	Déconseillé : représentation publique de la récupération d’une opération de sondage de certificat supprimée
RequireAtLeastOne	RequireAtLeastOne permet de créer un type où 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) n’est valide que 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 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 de setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	Alternatives à la propriété objet. S’il est présent, il doit au moins avoir l’une des propriétés de SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions	Options de 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	Reflète le niveau de récupération de suppression actuellement en vigueur pour les secrets dans le coffre actuel. S’il contient « Purgeable », le secret peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le secret, à la fin de l’intervalle de rétention.
KnownKeyUsageTypes	Valeurs connues de KeyUsageType que le service accepte.
WellKnownIssuer	Émetteurs connus pour choisir une valeur par défaut

Functions

parseKeyVaultCertificateIdentifier(string)

Analyse l’ID de certificat Key Vault indiqué. Un exemple est :

https://< nom-keyvault.vault.azure.net/certificates/>< nom-de-certificat>/<id-version-unique>

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

Variables

DefaultCertificatePolicy	Le DefaultCertificatePolicy exporte les valeurs utiles comme paramètres par défaut vers des méthodes qui modifient la politique du certificat.
logger

parseKeyVaultCertificateIdentifier(string)

Analyse l’ID de certificat Key Vault indiqué. Un exemple est :

https://< nom-keyvault.vault.azure.net/certificates/>< nom-de-certificat>/<id-version-unique>

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

L’identifiant du certificat Key Vault.

Retours

KeyVaultCertificateIdentifier

DefaultCertificatePolicy

Le DefaultCertificatePolicy exporte les valeurs utiles comme paramètres par défaut vers des méthodes qui modifient la politique du certificat.

DefaultCertificatePolicy: { issuerName: string, subject: string }

Type

{ issuerName: string, subject: string }

logger

logger: AzureLogger

Type

AzureLogger

Partager via

@azure/keyvault-certificates package

Classes

Interfaces

Alias de type

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Énumérations

Functions

Variables

Informations relatives à la fonction

parseKeyVaultCertificateIdentifier(string)

Paramètres

Retours

Détails de variable

DefaultCertificatePolicy

Type

logger

Type