@azure/arm-keyvault package

类

KeyVaultManagementClient

接口

AccessPolicyEntry	有权访问密钥保管库的标识。 数组中的所有标识都必须使用与密钥保管库租户 ID 相同的租户 ID。
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	表示密钥操作的接口。
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	表示ManagedHsmKey操作的接口。
ManagedHsmLifetimeAction	model interface ManagedHsmLifetimeAction
ManagedHsmProperties	托管 HSM 池的属性
ManagedHsmRotationPolicy	模型接口 ManagedHsmRotationPolicy
ManagedHsmSku	SKU 详细信息
ManagedHsmTrigger	model interface ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	可选参数。
ManagedHsmsCreateOrUpdateOptionalParams	可选参数。
ManagedHsmsDeleteOptionalParams	可选参数。
ManagedHsmsGetDeletedOptionalParams	可选参数。
ManagedHsmsGetOptionalParams	可选参数。
ManagedHsmsListByResourceGroupOptionalParams	可选参数。
ManagedHsmsListBySubscriptionOptionalParams	可选参数。
ManagedHsmsListDeletedOptionalParams	可选参数。
ManagedHsmsOperations	表示ManagedHsms操作的接口。
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	Key Vault REST API作定义。
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	所有 Azure 资源管理器资源的响应中返回的常见字段
RestorePollerOptions
RotationPolicy	模型接口旋转策略
Secret	具有扩展详细信息的资源信息。
SecretAttributes	机密管理属性。
SecretCreateOrUpdateParameters	用于创建或更新机密的参数
SecretPatchParameters	用于修补机密的参数
SecretPatchProperties	机密的属性
SecretProperties	机密的属性
SecretsCreateOrUpdateOptionalParams	可选参数。
SecretsGetOptionalParams	可选参数。
SecretsListOptionalParams	可选参数。
SecretsOperations	表示秘密操作的接口。
SecretsUpdateOptionalParams	可选参数。
ServiceSpecification	作的一个属性，包括日志规范。
SimplePollerLike	可用于轮询长时间运行的操作的简单轮询程序。
Sku	SKU 详细信息
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
Trigger	模型接口触发器
UserAssignedIdentity	用户分配的标识属性
Vault	具有扩展详细信息的资源信息。
VaultAccessPolicyParameters	用于更新保管库中访问策略的参数
VaultAccessPolicyProperties	保管库访问策略的属性
VaultCheckNameAvailabilityParameters	用于检查保管库名称可用性的参数。
VaultCreateOrUpdateParameters	用于创建或更新保管库的参数
VaultPatchParameters	用于创建或更新保管库的参数
VaultPatchProperties	保管库的属性
VaultProperties	保管库的属性
VaultsCheckNameAvailabilityOptionalParams	可选参数。
VaultsCreateOrUpdateOptionalParams	可选参数。
VaultsDeleteOptionalParams	可选参数。
VaultsGetDeletedOptionalParams	可选参数。
VaultsGetOptionalParams	可选参数。
VaultsListByResourceGroupOptionalParams	可选参数。
VaultsListBySubscriptionOptionalParams	可选参数。
VaultsListDeletedOptionalParams	可选参数。
VaultsListOptionalParams	可选参数。
VaultsOperations	表示 Vault作的接口。
VaultsPurgeDeletedOptionalParams	可选参数。
VaultsUpdateAccessPolicyOptionalParams	可选参数。
VaultsUpdateOptionalParams	可选参数。
VirtualNetworkRule	一个规则，用于控制来自特定虚拟网络的保管库的可访问性。

类型别名

AccessPolicyUpdateKind	访问类型：PolicyUpdateKind
ActionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。 KnownActionsRequired 可与 ActionsRequired 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无
ActivationStatus	激活状态 KnownActivationStatus 可与 ActivationStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 活动：托管 HSM 池处于活动状态。 NotActivated：尚未激活托管 HSM 池。 未知：激活托管 hsm 时发生未知错误。 失败：无法激活托管 hsm。
AzureSupportedClouds	云设置为字符串文字类型的支持值
CertificatePermissions	证书权限类型
ContinuablePage	描述结果页的接口。
CreateMode	保管库的创建模式，用于指示是否需要恢复保管库。
CreatedByType	创建资源的实体类型。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：实体是由用户创建的。 应用程序：实体是由应用程序创建的。 ManagedIdentity：实体是由托管标识创建的。 密钥：实体是由密钥创建的。
DeletionRecoveryLevel	当前该对象的删除恢复等级。 如果包含“可清除”，则该对象可以被特权用户永久删除;否则，只有系统能在保留区间结束时清除该对象。 KnownDeletionRecoveryLevel 可与 DeletionRecoveryLevel 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 可清除 可恢复+可清除 可恢复 可恢复+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	键权限类型
KeyRotationPolicyActionType	操作的类型。
ManagedHsmSkuFamily	托管HSM池的SKU家族 KnownManagedHsmSkuFamily 可与 ManagedHsmSkuFamily 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 B C
ManagedHsmSkuName	托管 HSM 池的 SKU
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。 KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无：无托管标识。 SystemAssigned：系统分配的托管标识。 UserAssigned：用户分配的托管标识。 SystemAssigned、UserAssigned：系统和用户分配的托管标识。
NetworkRuleAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认操作。 仅当评估绕过属性后，才使用此属性。 KnownNetworkRuleAction 可与 NetworkRuleAction 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 允许 拒绝
NetworkRuleBypassOptions	告知哪些流量可以绕过网络规则。 这可以是“AzureServices”或“None”。 如果未指定默认值，则为“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	无法使用保管库名称的原因。 仅当 NameAvailable 为 false 时，才返回 Reason 元素。 KnownReason 可以与 Reason 互换使用，这个枚举包含服务支持的已知值。 服务支持的已知值 账户名称无效 已经存在
SecretPermissions	秘密权限类型
SkuFamily	SKU家族名称 KnownSkuFamily 可与 SkuFamily 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 A
SkuName	用于指定密钥保管库是标准保管库还是高级保管库的 SKU 名称。
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	托管 HSM 池的 SKU 系列
KnownManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
KnownNetworkRuleAction	当没有来自 ipRules 和 virtualNetworkRules 的规则匹配时，默认操作。 仅当评估绕过属性后，才使用此属性。
KnownNetworkRuleBypassOptions	告知哪些流量可以绕过网络规则。 这可以是“AzureServices”或“None”。 如果未指定默认值，则为“AzureServices”。
KnownPrivateEndpointConnectionProvisioningState	当前预配状态。
KnownPrivateEndpointServiceConnectionStatus	专用终结点连接状态。
KnownProvisioningState	预配状态。
KnownPublicNetworkAccess	从公用网络控制对托管 HSM 的权限。
KnownReason	无法使用保管库名称的原因。 仅当 NameAvailable 为 false 时，才返回 Reason 元素。
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>