@azure/arm-keyvault package

Классы

KeyVaultManagementClient

Интерфейсы

AccessPolicyEntry	Удостоверение, которое имеет доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей.
Action	Интерфейс модели Действие
Attributes	Атрибуты объекта, управляемые службой KeyVault.
CheckMhsmNameAvailabilityParameters	Параметры, используемые для проверки доступности управляемого имени hsm.
CheckMhsmNameAvailabilityResult	Ответ операции CheckMhsmNameAvailability.
CheckNameAvailabilityResult	Ответ операции CheckNameAvailability.
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
DeletedManagedHsm	Конкретные типы ресурсов прокси-сервера можно создать путем псевдонима этого типа с помощью определенного типа свойства.
DeletedManagedHsmProperties	Свойства удаленного управляемого устройства HSM.
DeletedVault	Удалены сведения о хранилище с расширенными сведениями.
DeletedVaultProperties	Свойства удаленного хранилища.
DimensionProperties	Тип операции: получение, чтение, удаление и т. д.
ErrorModel	Ошибка сервера.
IPRule	Правило, которое управляет специальными возможностями хранилища из определенного IP-адреса или диапазона IP-адресов.
Key	Ключевой ресурс.
KeyAttributes	Атрибуты объекта, управляемые службой Azure Key Vault.
KeyCreateParameters	Параметры, используемые для создания ключа.
KeyProperties	Свойства ключа.
KeyReleasePolicy	интерфейс модели KeyReleasePolicy
KeyRotationPolicyAttributes	интерфейс модели KeyRotationPolicyAttributes
KeyVaultManagementClientOptionalParams	Необязательные параметры для клиента.
KeysCreateIfNotExistOptionalParams	Необязательные параметры.
KeysGetOptionalParams	Необязательные параметры.
KeysGetVersionOptionalParams	Необязательные параметры.
KeysListOptionalParams	Необязательные параметры.
KeysListVersionsOptionalParams	Необязательные параметры.
KeysOperations	Интерфейс, представляющий операции Key.
LifetimeAction	интерфейс модели LifetimeAction
LogSpecification	Спецификация журнала операции.
ManagedHSMSecurityDomainProperties	Свойства домена безопасности управляемого hsm.
ManagedHsm	Сведения о ресурсе с расширенными сведениями.
ManagedHsmAction	model interface ManagedHsmAction
ManagedHsmError	Исключение ошибки.
ManagedHsmKey	Ключевой ресурс.
ManagedHsmKeyAttributes	Атрибуты объекта, управляемые службой Azure Key Vault.
ManagedHsmKeyCreateParameters	Параметры, используемые для создания ключа.
ManagedHsmKeyProperties	Свойства ключа.
ManagedHsmKeyReleasePolicy	model interface managedHsmKeyReleasePolicy
ManagedHsmKeyRotationPolicyAttributes	model interface ManagedHsmKeyRotationPolicyAttributes
ManagedHsmKeysCreateIfNotExistOptionalParams	Необязательные параметры.
ManagedHsmKeysGetOptionalParams	Необязательные параметры.
ManagedHsmKeysGetVersionOptionalParams	Необязательные параметры.
ManagedHsmKeysListOptionalParams	Необязательные параметры.
ManagedHsmKeysListVersionsOptionalParams	Необязательные параметры.
ManagedHsmKeysOperations	Интерфейс, представляющий управляемые операции HsmKeys.
ManagedHsmLifetimeAction	model interface ManagedHsmLifetimeAction
ManagedHsmProperties	Свойства управляемого пула HSM
ManagedHsmRotationPolicy	интерфейс модели Managed HsmRotationPolicy
ManagedHsmSku	Сведения о номере SKU
ManagedHsmTrigger	model interface ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	Необязательные параметры.
ManagedHsmsCreateOrUpdateOptionalParams	Необязательные параметры.
ManagedHsmsDeleteOptionalParams	Необязательные параметры.
ManagedHsmsGetDeletedOptionalParams	Необязательные параметры.
ManagedHsmsGetOptionalParams	Необязательные параметры.
ManagedHsmsListByResourceGroupOptionalParams	Необязательные параметры.
ManagedHsmsListBySubscriptionOptionalParams	Необязательные параметры.
ManagedHsmsListDeletedOptionalParams	Необязательные параметры.
ManagedHsmsOperations	Интерфейс, представляющий управляемые операции Hsms.
ManagedHsmsPurgeDeletedOptionalParams	Необязательные параметры.
ManagedHsmsUpdateOptionalParams	Необязательные параметры.
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
MetricSpecification	Спецификация метрики операции.
MhsmGeoReplicatedRegion	Регион, в который был расширен управляемый пул HSM.
MhsmNetworkRuleSet	Набор правил, определяющих доступность сети управляемого пула hsm.
MhsmPrivateEndpoint	Свойства объекта частной конечной точки.
MhsmPrivateEndpointConnection	Ресурс подключения к частной конечной точке.
MhsmPrivateEndpointConnectionItem	Элемент подключения к частной конечной точке.
MhsmPrivateEndpointConnectionProperties	Свойства ресурса подключения к частной конечной точке.
MhsmPrivateEndpointConnectionsDeleteOptionalParams	Необязательные параметры.
MhsmPrivateEndpointConnectionsGetOptionalParams	Необязательные параметры.
MhsmPrivateEndpointConnectionsListByResourceOptionalParams	Необязательные параметры.
MhsmPrivateEndpointConnectionsOperations	Интерфейс, представляющий операции MhsmPrivateEndpointConnections.
MhsmPrivateEndpointConnectionsPutOptionalParams	Необязательные параметры.
MhsmPrivateLinkResource	Ресурс приватного канала
MhsmPrivateLinkResourceListResult	Список ресурсов приватного канала
MhsmPrivateLinkResourceProperties	Свойства ресурса приватного канала.
MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams	Необязательные параметры.
MhsmPrivateLinkResourcesOperations	Интерфейс, представляющий операции MhsmPrivateLinkResources.
MhsmPrivateLinkServiceConnectionState	Объект, представляющий состояние утверждения подключения приватного канала.
MhsmRegionsListByResourceOptionalParams	Необязательные параметры.
MhsmRegionsOperations	Интерфейс, представляющий операции MhsmRegions.
MhsmServiceTagRule	Правило, регулирующее доступность управляемого пула HSM из конкретных сервисных тегов.
MhsmVirtualNetworkRule	Правило, которое управляет специальными возможностями управляемого пула hsm из определенной виртуальной сети.
MhsmipRule	Правило, регулирующее доступность управляемого пула HSM из определенного IP-адреса или диапазона IP-адресов.
NetworkRuleSet	Набор правил, определяющих доступность сети хранилища.
Operation	Определение операции REST API Key Vault.
OperationDisplay	Отображение метаданных, связанных с операцией.
OperationProperties	Свойства работы, включают в себя метрические характеристики.
OperationsListOptionalParams	Необязательные параметры.
OperationsOperations	Интерфейс, представляющий операции операций.
PageSettings	Параметры метода byPage
PagedAsyncIterableIterator	Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
Permissions	Разрешения удостоверения имеются для ключей, секретов, сертификатов и хранилища.
PrivateEndpoint	Свойства объекта частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionItem	Элемент подключения к частной конечной точке.
PrivateEndpointConnectionProperties	Свойства ресурса подключения к частной конечной точке.
PrivateEndpointConnectionsDeleteOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsGetOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsListByResourceOptionalParams	Необязательные параметры.
PrivateEndpointConnectionsOperations	Интерфейс, представляющий операции PrivateEndpointConnections.
PrivateEndpointConnectionsPutOptionalParams	Необязательные параметры.
PrivateLinkResource	Ресурс приватного канала
PrivateLinkResourceListResult	Список ресурсов приватного канала
PrivateLinkResourceProperties	Свойства ресурса приватного канала.
PrivateLinkResourcesListByVaultOptionalParams	Необязательные параметры.
PrivateLinkResourcesOperations	Интерфейс, представляющий операции PrivateLinkResources.
PrivateLinkServiceConnectionState	Объект, представляющий состояние утверждения подключения приватного канала.
ProxyResource	Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
Resource	Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
RestorePollerOptions
RotationPolicy	Модель интерфейса RotPolicy
Secret	Сведения о ресурсе с расширенными сведениями.
SecretAttributes	Атрибуты управления секретами.
SecretCreateOrUpdateParameters	Параметры для создания или обновления секрета
SecretPatchParameters	Параметры для исправления секрета
SecretPatchProperties	Свойства секрета
SecretProperties	Свойства секрета
SecretsCreateOrUpdateOptionalParams	Необязательные параметры.
SecretsGetOptionalParams	Необязательные параметры.
SecretsListOptionalParams	Необязательные параметры.
SecretsOperations	Интерфейс, представляющий операции Secrets.
SecretsUpdateOptionalParams	Необязательные параметры.
ServiceSpecification	Одно свойство операции, включаемое спецификации журнала.
SimplePollerLike	Простой опросщик, который можно использовать для опроса длительной операции.
Sku	Сведения о номере SKU
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TrackedResource	Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
Trigger	Триггер интерфейса модели
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
Vault	Сведения о ресурсе с расширенными сведениями.
VaultAccessPolicyParameters	Параметры обновления политики доступа в хранилище
VaultAccessPolicyProperties	Свойства политики доступа к хранилищу
VaultCheckNameAvailabilityParameters	Параметры, используемые для проверки доступности имени хранилища.
VaultCreateOrUpdateParameters	Параметры для создания или обновления хранилища
VaultPatchParameters	Параметры для создания или обновления хранилища
VaultPatchProperties	Свойства хранилища
VaultProperties	Свойства хранилища
VaultsCheckNameAvailabilityOptionalParams	Необязательные параметры.
VaultsCreateOrUpdateOptionalParams	Необязательные параметры.
VaultsDeleteOptionalParams	Необязательные параметры.
VaultsGetDeletedOptionalParams	Необязательные параметры.
VaultsGetOptionalParams	Необязательные параметры.
VaultsListByResourceGroupOptionalParams	Необязательные параметры.
VaultsListBySubscriptionOptionalParams	Необязательные параметры.
VaultsListDeletedOptionalParams	Необязательные параметры.
VaultsListOptionalParams	Необязательные параметры.
VaultsOperations	Интерфейс, представляющий операции Vaults.
VaultsPurgeDeletedOptionalParams	Необязательные параметры.
VaultsUpdateAccessPolicyOptionalParams	Необязательные параметры.
VaultsUpdateOptionalParams	Необязательные параметры.
VirtualNetworkRule	Правило, которое управляет специальными возможностями хранилища из определенной виртуальной сети.

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

AccessPolicyUpdateKind	Тип доступаPolicyUpdateKind
ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя. KnownActionsRequired можно использовать взаимозаменяемо с ActionsRequired, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Нет
ActivationStatus	Статус активации KnownActivationStatus можно использовать взаимозаменяемо с ActivationStatus, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой активный: управляемый пул HSM активен. NotActivated: управляемый пул HSM еще не активирован. Неизвестное: при активации управляемого hsm произошла неизвестная ошибка. сбой: не удалось активировать управляемый hsm.
AzureSupportedClouds	Поддерживаемые значения для настройки облака в виде строкового литерала
CertificatePermissions	Тип CertificatePermissions
ContinuablePage	Интерфейс, описывающий страницу результатов.
CreateMode	Режим создания хранилища, указывающий, требуется ли восстановить хранилище.
CreatedByType	Тип сущности, создающей ресурс. KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой user: сущность была создана пользователем. приложения: сущность была создана приложением. ManagedIdentity: сущность была создана управляемым удостоверением. ключ: сущность была создана ключом.
DeletionRecoveryLevel	Уровень восстановления после удаления, действующий в настоящее время для объекта. Если в нем есть «Очищение», то объект может быть навсегда удалён привилегированным пользователем; в противном случае только система может очистить объект в конце интервала удержания. KnownDeletionRecoveryLevel можно использовать взаимозаменяемо с удалениемRecoveryLevel, в этом перечислении содержатся известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой очистка восстановление и очистка можно восстановить восстановление и protectedSubscription
GeoReplicationRegionProvisioningState	Текущее состояние подготовки. KnownGeoReplicationRegionProvisioningState можно использовать взаимозаменяемо с GeoReplicationRegionProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой предварительной подготовки подготовки успешно выполнено Сбой удаление очистка
JsonWebKeyCurveName	Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName. По умолчанию для клавиш EC и EC-HSM — P-256 KnownJsonWebKeyCurveName можно использовать взаимозаменяемо с JsonWebKeyCurveName, в этом перечислении содержатся известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой P-256 P-384 P-521 P-256K
JsonWebKeyOperation	Разрешённые JSON-веб-ключи для ключа. Дополнительные сведения см. в разделе JsonWebKeyOperation. KnownJsonWebKeyOperation можно использовать взаимозаменяемо с JsonWebKeyOperation, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой шифрования расшифровка знак проверить wrapKey unwrapKey импорт выпуска
JsonWebKeyType	Тип ключа. Допустимые значения см. в разделе JsonWebKeyType. KnownJsonWebKeyType можно использовать взаимозаменяемо с JsonWebKeyType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой EC EC-HSM RSA RSA-HSM
KeyPermissions	Тип KeyPermissions
KeyRotationPolicyActionType	Тип действия.
ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM KnownManagedHskuSkuFamily можно использовать взаимозаменяемо с ManagedHsmSkuFamily, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой B C
ManagedHsmSkuName	SKU управляемого пула HSM
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). KnownManagedServiceIdentityType можно использовать взаимозаменяемо с ManagedServiceIdentityType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Нет: Нет управляемой идентификации. SystemAssigned: управляемое удостоверение, назначаемое системой. UserAssigned: управляемое удостоверение, назначаемое пользователем. SystemAssigned,UserAssigned: управляемое удостоверение, назначаемое системой и пользователем.
NetworkRuleAction	Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода. KnownNetworkRuleAction можно использовать взаимозаменяемо с NetworkRuleAction, в этом перечислении содержатся известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой разрешить запретить
NetworkRuleBypassOptions	Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices. KnownNetworkRuleBypassOptions можно использовать взаимозаменяемо с NetworkRuleBypassOptions, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой AzureServices Нет
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки. KnownPrivateEndpointConnectionProvisioningState можно использовать взаимозаменяемо с PrivateEndpointConnectionProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой успешно выполнено создание обновление удаление Сбой отключенные
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке. KnownPrivateEndpointServiceConnectionStatus можно использовать взаимозаменяемо с PrivateEndpointServiceConnectionStatus, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой ожидающих утвержденные отклоненные отключенные
ProvisioningState	Состояние подготовки. KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой успешно выполнено: управляемый пул HSM был полностью подготовлен. подготовка: управляемый пул HSM в настоящее время подготавливается. сбой: сбой подготовки управляемого пула HSM. обновление: в настоящее время обновляется управляемый пул HSM. удалении: управляемый пул HSM в настоящее время удаляется. активированные: управляемый пул HSM готов к обычному использованию. SecurityDomainRestore: управляемый пул HSM ожидает действия восстановления домена безопасности. восстановление: управляемый пул HSM восстанавливается из полной резервной копии HSM.
PublicNetworkAccess	Управление разрешением на управляемый HSM из общедоступных сетей. KnownPublicNetworkAccess можно использовать взаимозаменяемо с PublicNetworkAccess, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой включено отключены
Reason	Причина, по которой не удалось использовать имя хранилища. Элемент Reason возвращается только в том случае, если NameAvailable имеет значение false. KnownReason может использоваться взаимозаменяемо с Reason, этот enum содержит известные значения, поддерживаемые сервисом. Известные значения, поддерживаемые службой AccountNameInvalid Уже
SecretPermissions	Тип SecretPermissions
SkuFamily	Фамилия SKU KnownSkuFamily можно использовать взаимозаменяемо с SkuFamily, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой A
SkuName	Имя SKU, указывающее, является ли хранилище ключей стандартным хранилищем или хранилищем класса Premium.
StoragePermissions	Тип StoragePermissions
VaultProvisioningState	Состояние подготовки хранилища. KnownVaultProvisioningState можно использовать взаимозаменяемо с VaultProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой успешно выполнено RegisteringDns

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

AzureClouds	Перечисление для описания облачных сред Azure.
KnownActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
KnownActivationStatus	Статус активации
KnownCertificatePermissions	Известные значения CertificatePermissions, которые служба принимает.
KnownCreatedByType	Тип сущности, создающей ресурс.
KnownDeletionRecoveryLevel	Уровень восстановления после удаления, действующий в настоящее время для объекта. Если в нем есть «Очищение», то объект может быть навсегда удалён привилегированным пользователем; в противном случае только система может очистить объект в конце интервала удержания.
KnownGeoReplicationRegionProvisioningState	Текущее состояние подготовки.
KnownJsonWebKeyCurveName	Имя эллиптической кривой. Допустимые значения см. в разделе JsonWebKeyCurveName. По умолчанию для ключей EC и EC-HSM используется P-256
KnownJsonWebKeyOperation	Разрешённые JSON-веб-ключи для ключа. Дополнительные сведения см. в разделе JsonWebKeyOperation.
KnownJsonWebKeyType	Тип ключа. Допустимые значения см. в разделе JsonWebKeyType.
KnownKeyPermissions	Известные значения KeyPermissions, которые служба принимает.
KnownManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
KnownManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
KnownNetworkRuleAction	Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.
KnownNetworkRuleBypassOptions	Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices.
KnownPrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
KnownPrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
KnownProvisioningState	Состояние подготовки.
KnownPublicNetworkAccess	Управление разрешением на управляемый HSM из общедоступных сетей.
KnownReason	Причина, по которой не удалось использовать имя хранилища. Элемент Reason возвращается только в том случае, если NameAvailable имеет значение false.
KnownSecretPermissions	Известные значения SecretPermissions, которые служба принимает.
KnownSkuFamily	Имя семейства SKU
KnownStoragePermissions	Известные значения StoragePermissions, которые служба принимает.
KnownVaultProvisioningState	Состояние подготовки хранилища.
KnownVersions	Доступные версии API.

Функции

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

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

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Параметры

client

KeyVaultManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

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

PollerLike<OperationState<TResult>, TResult>