Поделиться через

@azure/keyvault-certificates package

Классы

CertificateClient

Клиент для взаимодействия с функциями сертификатов KeyVault

Интерфейсы

AdministratorContact

Сведения администратора организации издателя сертификата.
BackupCertificateResult

Результат сертификата резервного копирования, содержащий большой двоичный объект резервного копирования.
BeginCreateCertificateOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions

Необязательные параметры, принятые сертификатом KeyVault
CertificateContactAll

Форма контактных данных для сертификатов хранилища.
CertificateIssuer

Интерфейс, представляющий свойства издателя.
CertificateOperation

Операция сертификата возвращается в случае асинхронных запросов.
CertificateOperationError

Ошибка сервера хранилища ключей.
CertificateOperationState

Интерфейс, представляющий общедоступные свойства состояния CertificateOperationPoller.
CertificatePolicyProperties

Интерфейс, представляющий политику сертификата (без свойств субъекта).
CertificatePollerOptions

Интерфейс, представляющий необязательные параметры, которые можно передать beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) и beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties

Интерфейс, представляющий свойства сертификата
CoreSubjectAlternativeNames

Альтернативные имена субъекта объекта X509.
CreateCertificateOptions

Параметры <xref:createCertificate>.
CreateIssuerOptions

Параметры createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate

Интерфейс, представляющий удаленный сертификат.
ErrorModel

Модель ошибки сервера хранилища ключей.
ImportCertificateOptions

Параметры importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes

Атрибуты издателя, управляемого службой Key Vault.
IssuerCredentials

Учетные данные, используемые для издателя сертификатов.
IssuerParameters

Параметры для издателя компонента X509 сертификата.
IssuerProperties

Интерфейс, представляющий свойства издателя сертификата
KeyVaultCertificate

Интерфейс, представляющий сертификат без политики сертификата
KeyVaultCertificateIdentifier

Представляет сегменты, составляющие идентификатор сертификата Key Vault.
KeyVaultCertificatePollOperationState

Интерфейс, представляющий общедоступную форму состояния операций опроса сертификатов Key Vault.
KeyVaultCertificateWithPolicy

Интерфейс, представляющий сертификат со своей политикой
LifetimeAction

Действие и его триггер, которые будут выполняться Key Vault в течение всего времени существования сертификата.
ListDeletedCertificatesOptions

Интерфейс, представляющий необязательные параметры для операций с страницами CertificateClient, передаваемых в listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions

Интерфейс, представляющий необязательные параметры для операций с страницами CertificateClient, передаваемых в listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties

Интерфейс, представляющий возможные свойства субъекта политики сертификата. Для конечного типа требуется по крайней мере один из этих свойств.
PollerLike

Абстрактное представление опроса, предназначенное для предоставления только минимального API, с которым должен работать пользователь.
PollerLikeWithCancellation

Абстрактное представление опроса, предназначенное для предоставления только минимального API, с которым должен работать пользователь.
SubjectAlternativeNamesAll

Интерфейс, представляющий альтернативные имена субъекта политики сертификата.
UpdateCertificateOptions

Параметры <xref:updateCertificate>.
UpdateIssuerOptions

Параметры updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties

Свойства компонента X509 сертификата.

Псевдонимы типа

ActionType

Действие, которое будет выполняться.
ArrayOneOrMore

Массив с одним свойством как минимум.
BackupCertificateOptions

Параметры backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions

Параметры <xref:cancelCertificateOperation>.
CertificateContact

Контактные данные для сертификатов хранилища. Каждый контакт будет иметь по крайней мере одно из свойств CertificateContactAll, которые: emailAddress, имя или телефон.
CertificateContentType

Определяет значения contentType. Возможные значения: application/x-pem-file, application/x-pkcs12
CertificateKeyCurveName

Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> можно использовать взаимозаменяемо с JsonWebKeyCurveName, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

P-256: NIST P-256 многоточие кривой, AKA SECG кривая SECP256R1.
P-384: кривая NIST P-384 с многоточием, кривая AKA SECG SECP384R1.
P-521: кривая NIST P-521 с многоточием, кривая AKA SECG SECP521R1.
P-256K: SECP256K1 эллиптической кривой SECG.
CertificateKeyType

Тип пары ключей, используемой для сертификата.
<xref:KnownJsonWebKeyType> можно использовать взаимозаменяемо с JsonWebKeyType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

EC: эллиптическая кривая.
EC-HSM: эллиптическая кривая с закрытым ключом, который не экспортируется из HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM: RSA с закрытым ключом, который не экспортируется из HSM.
окт: последовательность октетов (используется для представления симметричные ключи).
окт-HSM: последовательность октетов с закрытым ключом, который не экспортируется из HSM.
CertificatePolicy

Тип, представляющий политику сертификата по крайней мере с одним из свойств субъекта.
CertificatePolicyAction

Действие, которое будет выполняться.
CertificateTags

Интерфейс, представляющий форму тегов сертификата. Теги — это только пары "ключ-значение" строки.
CreateCertificateState

Общедоступное представление состояния операции CreateCertificatePoller.
DeleteCertificateOperationOptions

Параметры deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState

Общедоступное представление состояния операции DeleteCertificatePoller.
DeleteContactsOptions

Параметры deleteContacts(OperationOptions).
DeleteIssuerOptions

Параметры deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel

Отражает уровень восстановления удаления, который в настоящее время действует для секретов в текущем хранилище. Если он содержит "Purgeable", секрет может быть окончательно удален привилегированным пользователем; в противном случае только система может очистить секрет в конце интервала хранения.
<xref:KnownDeletionRecoveryLevel> можно использовать взаимозаменяемо с удалениемRecoveryLevel, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

очистка: обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень не соответствует защите от операции delete; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.).
Восстановление и очистка: обозначает состояние хранилища, в котором можно восстановить, а также разрешает немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если операция очистки не запрашивается или подписка отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
можно восстановить: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка по-прежнему доступна. Система будет окончательно удалять ее через 90 дней, если не восстановлена
recoveryable+ProtectedSubscription: обозначает хранилище и состояние подписки, в котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) не допускается, и при этом сама подписка не может быть окончательно отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
Настраиваемыйrecoverable+Purgeable: обозначает состояние хранилища, в котором можно восстановить удаление, а также разрешает немедленное и постоянное удаление (т. е. очистка при 7 <= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, если не запрашивается операция очистки или подписка отменена.
Настраиваемый: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистка при 7 <= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время периода хранения и пока подписка по-прежнему доступна.
Настраиваемыйrecoverable+ProtectedSubscription: обозначает состояние хранилища и подписки, в котором удаление можно восстановить, немедленное и постоянное удаление (т. е. очистка) не разрешено, и при этом сама подписка не может быть окончательно отменена, когда 7 <= SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.
GetCertificateOperationOptions

Параметры getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions

Параметры getCertificate(string, OperationOptions).
GetCertificatePolicyOptions

Параметры getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions

Параметры getCertificateVersion(string, string, OperationOptions).
GetContactsOptions

Параметры getContacts(OperationOptions).
GetDeletedCertificateOptions

Параметры getDeletedCertificate(string, OperationOptions).
GetIssuerOptions

Параметры getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions

Параметры <xref:getPlainCertificateOperation>.
ImportCertificatePolicy

Тип, представляющий политику сертификата для импорта, для которой не требуется SAN или тема
KVPollerLike

Нерекомендуемая копия KeyVault в PollerLike core-lro.
KeyUsageType

Поддерживаемые использование ключа сертификата.
<xref:KnownKeyUsageType> можно использовать взаимозаменяемо с KeyUsageType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

digitalSignature: указывает, что ключ сертификата можно использовать в качестве цифровой подписи.
неrepudiation: указывает, что ключ сертификата можно использовать для проверки подлинности.
keyEncipherment: указывает, что ключ сертификата можно использовать для шифрования ключей.
dataEncipherment: указывает, что ключ сертификата можно использовать для шифрования данных.
keyAgreement: указывает, что ключ сертификата можно использовать для определения соглашения ключа, например ключа, созданного с помощью алгоритма соглашения Diffie-Hellman ключей.
keyCertSign: указывает, что ключ сертификата можно использовать для подписывания сертификатов.
cRLSign: указывает, что ключ сертификата можно использовать для подписи списка отзыва сертификатов.
encipherOnly: указывает, что ключ сертификата можно использовать только для шифрования.
расшифровки: указывает, что ключ сертификата можно использовать только для расшифровки.
ListPropertiesOfCertificateVersionsOptions

Интерфейс, представляющий необязательные параметры для операций с страницами CertificateClient, передаваемых в listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions

Интерфейс, представляющий необязательные параметры для операций с страницами CertificateClient, передаваемых в listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions

Интерфейс, представляющий необязательные параметры для mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions

Параметры purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState

Устаревшее: общедоступное представление восстановления удаленной операции опроса сертификатов
RequireAtLeastOne

RequireAtLeastOne помогает создать тип, в котором требуется по крайней мере одно из свойств интерфейса (может быть любым свойством).

Это работает из-за типов служебной программы TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html рассмотрим его:

  • [K in keyof T]-? это свойство (K) допустимо только в том случае, если оно имеет то же имя, что и любое свойство T.
  • Required<Pick<T, K>> делает новый тип из T только текущим свойством в итерации и помечает его как необходимое.
  • Partial<Pick<T, Exclude<keyof T, K>>> создает новый тип со всеми свойствами T, кроме свойства K.
  • & заключается в том, что объединяет тип только с одним обязательным свойством из Required<...> со всеми необязательными свойствами из Partial<...>.
  • [keyof T] гарантирует, что разрешены только свойства T.
RestoreCertificateBackupOptions

Интерфейс, представляющий необязательные параметры для restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions

Параметры setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames

Альтернативные варианты свойства субъекта. Если он присутствует, он должен иметь хотя бы одно из свойств SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions

Параметры updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Перечисления

KnownCertificateKeyCurveNames

Известные значения CertificateKeyCurveName, которые принимает служба.
KnownCertificateKeyTypes

Известные значения CertificateKeyType, которые принимает служба.
KnownDeletionRecoveryLevels

Отражает уровень восстановления удаления, который в настоящее время действует для секретов в текущем хранилище. Если он содержит "Purgeable", секрет может быть окончательно удален привилегированным пользователем; в противном случае только система может очистить секрет в конце интервала хранения.
KnownKeyUsageTypes

Известные значения KeyUsageType, которые принимает служба.
WellKnownIssuer

Известные издатели для выбора по умолчанию

Функции

parseKeyVaultCertificateIdentifier(string)

Анализирует указанный идентификатор сертификата Key Vault. Пример:

https://< имя-ключа.vault.azure.net/certificates/>< имя-сертификата>/<уникальный-идентификатор версии-версии>

При анализе приведенного выше идентификатора эта функция возвращает следующее:

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

Переменные

DefaultCertificatePolicy

DefaultCertificatePolicy экспортирует значения, полезные в качестве стандартных параметров, в методы, изменяющие политику сертификата.
logger

@azure/logger Конфигурация для этого пакета.

Сведения о функции

parseKeyVaultCertificateIdentifier(string)

Анализирует указанный идентификатор сертификата Key Vault. Пример:

https://< имя-ключа.vault.azure.net/certificates/>< имя-сертификата>/<уникальный-идентификатор версии-версии>

При анализе приведенного выше идентификатора эта функция возвращает следующее:

  {
     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

Параметры

id

string

Идентификатор сертификата Key Vault.

Возвращаемое значение

KeyVaultCertificateIdentifier

Variable Details

DefaultCertificatePolicy

DefaultCertificatePolicy экспортирует значения, полезные в качестве стандартных параметров, в методы, изменяющие политику сертификата.

DefaultCertificatePolicy: { issuerName: string, subject: string }

Тип

{ issuerName: string, subject: string }

logger

@azure/logger Конфигурация для этого пакета.

logger: AzureLogger

Тип

AzureLogger