@azure/keyvault-certificates package

  • Ссылка

Классы

CertificateClient

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

Интерфейсы

AdministratorContact

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

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

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

Необязательные параметры, принимаемые CertificateClient хранилища ключей
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, с которым должен работать пользователь.
SubjectAlternativeNamesAll

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

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

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

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

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

ActionType

Определяет значения для ActionType.
ArrayOneOrMore

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

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

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

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

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

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

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

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

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

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

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

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

EC
EC-HSM
RSA
RSA-HSM
Октября
oct-HSM
CertificatePolicy

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

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

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

Открытое представление состояния операции CreateCertificatePoller.
DeleteCertificateOperationOptions

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

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

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

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

Определяет значения для Параметра DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> можно использовать взаимозаменяемо с DeletionRecoveryLevel. Это перечисление содержит известные значения, поддерживаемые службой.

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

Очищаемый. Обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень соответствует отсутствием защиты от операции удаления; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.);
Recoverable+Purgeable: обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение периода хранения (90 дней), если не запрошена операция очистки или подписка не отменена. Система окончательно удалите его через 90 дней, если она не восстановлена
Возможность восстановления. Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение периода хранения (90 дней) и пока подписка остается доступной. Система окончательно удалите его через 90 дней, если она не восстановлена
Recoverable+ProtectedSubscription. Обозначает состояние хранилища и подписки, в котором удаление можно восстановить в течение периода хранения (90 дней), немедленное и окончательное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена. Система окончательно удалите его через 90 дней, если она не восстановлена
CustomizedRecoverable+Purgeable: обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, если не запрошена операция очистки или подписка не отменена.
CustomizedRecoverable. Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения и в то время, когда подписка по-прежнему доступна.
CustomizedRecoverable+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 или subject
KVPollerLike

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

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

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

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly
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

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

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

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

KnownCertificateKeyCurveNames

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

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

Известные значения DeletionRecoveryLevel , которые принимает служба.
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>"
  }

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

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