@azure/keyvault-certificates package

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

EC
EC-HSM
RSA
RSA-HSM
октября
окт-HSM

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

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

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

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

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

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

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

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

Определяет значения для УдаленияRecoveryLevel.
<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. Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.

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

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

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

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

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

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

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

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

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

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

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

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

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
расшифровки

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

Анализирует указанный идентификатор сертификата 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>"
  }