你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

VaultProperties interface

保管库的属性

属性

accessPolicies

有权访问密钥保管库的 0 到 1024 标识的数组。 数组中的所有标识都必须使用与密钥保管库租户 ID 相同的租户 ID。 当 createMode 设置为 recover时,不需要访问策略。 否则,需要访问策略。

createMode

保管库的创建模式,用于指示是否需要恢复保管库。

enabledForDeployment

用于指定是否允许 Azure 虚拟机从密钥保管库检索存储为机密的证书的属性。

enabledForDiskEncryption

用于指定是否允许 Azure 磁盘加密从保管库检索机密和解包密钥的属性。

enabledForTemplateDeployment

用于指定是否允许 Azure 资源管理器从密钥保管库检索机密的属性。

enablePurgeProtection

指定是否为此保管库启用了针对清除的保护的属性。 将此属性设置为 true 可激活针对此保管库及其内容的清除保护 - 只有 Key Vault 服务可能会启动难以、不可恢复的删除。 仅当启用软删除时,此设置才有效。 启用此功能不可逆 - 也就是说,属性不接受 false 作为其值。

enableRbacAuthorization

用于控制如何授权数据作的属性。 如果为 true,密钥保管库将使用基于角色的访问控制(RBAC)来授权数据作,并且将忽略保管库属性中指定的访问策略。 如果为 false,密钥保管库将使用保管库属性中指定的访问策略,并且将忽略 Azure 资源管理器上存储的任何策略。 如果为 null 或未指定,则会使用默认值 false 创建保管库。 请注意,管理作始终使用 RBAC 进行授权。

enableSoftDelete

用于指定是否为此密钥保管库启用了“软删除”功能的属性。 如果在创建新密钥保管库时它未设置为任何值(true 或 false),则默认情况下会将其设置为 true。 设置为 true 后,无法将其还原为 false。

hsmPoolResourceId

HSM 池的资源 ID。 注意:此属性不会序列化。 它只能由服务器填充。

networkAcls

控制从特定网络位置访问密钥保管库的可访问性的规则。

privateEndpointConnections

与密钥保管库关联的专用终结点连接列表。 注意:此属性不会序列化。 它只能由服务器填充。

provisioningState

保管库的预配状态。

publicNetworkAccess

用于指定保管库是否接受来自公共 Internet 的流量的属性。 如果设置为“禁用”除专用终结点流量之外的所有流量,并且源自受信任的服务的所有流量将被阻止。 这将替代设置的防火墙规则,这意味着即使存在防火墙规则,我们也不会遵守这些规则。

sku

SKU 详细信息

softDeleteRetentionInDays

softDelete 数据保留天数。 它接受 >=7,<=90。

tenantId

应用于对密钥保管库的请求进行身份验证的 Azure Active Directory 租户 ID。

vaultUri

用于对密钥和机密执行作的保管库的 URI。

属性详细信息

accessPolicies

有权访问密钥保管库的 0 到 1024 标识的数组。 数组中的所有标识都必须使用与密钥保管库租户 ID 相同的租户 ID。 当 createMode 设置为 recover时,不需要访问策略。 否则,需要访问策略。

accessPolicies?: AccessPolicyEntry[]

属性值

createMode

保管库的创建模式,用于指示是否需要恢复保管库。

createMode?: CreateMode

属性值

enabledForDeployment

用于指定是否允许 Azure 虚拟机从密钥保管库检索存储为机密的证书的属性。

enabledForDeployment?: boolean

属性值

boolean

enabledForDiskEncryption

用于指定是否允许 Azure 磁盘加密从保管库检索机密和解包密钥的属性。

enabledForDiskEncryption?: boolean

属性值

boolean

enabledForTemplateDeployment

用于指定是否允许 Azure 资源管理器从密钥保管库检索机密的属性。

enabledForTemplateDeployment?: boolean

属性值

boolean

enablePurgeProtection

指定是否为此保管库启用了针对清除的保护的属性。 将此属性设置为 true 可激活针对此保管库及其内容的清除保护 - 只有 Key Vault 服务可能会启动难以、不可恢复的删除。 仅当启用软删除时,此设置才有效。 启用此功能不可逆 - 也就是说,属性不接受 false 作为其值。

enablePurgeProtection?: boolean

属性值

boolean

enableRbacAuthorization

用于控制如何授权数据作的属性。 如果为 true,密钥保管库将使用基于角色的访问控制(RBAC)来授权数据作,并且将忽略保管库属性中指定的访问策略。 如果为 false,密钥保管库将使用保管库属性中指定的访问策略,并且将忽略 Azure 资源管理器上存储的任何策略。 如果为 null 或未指定,则会使用默认值 false 创建保管库。 请注意,管理作始终使用 RBAC 进行授权。

enableRbacAuthorization?: boolean

属性值

boolean

enableSoftDelete

用于指定是否为此密钥保管库启用了“软删除”功能的属性。 如果在创建新密钥保管库时它未设置为任何值(true 或 false),则默认情况下会将其设置为 true。 设置为 true 后,无法将其还原为 false。

enableSoftDelete?: boolean

属性值

boolean

hsmPoolResourceId

HSM 池的资源 ID。 注意:此属性不会序列化。 它只能由服务器填充。

hsmPoolResourceId?: string

属性值

string

networkAcls

控制从特定网络位置访问密钥保管库的可访问性的规则。

networkAcls?: NetworkRuleSet

属性值

privateEndpointConnections

与密钥保管库关联的专用终结点连接列表。 注意:此属性不会序列化。 它只能由服务器填充。

privateEndpointConnections?: PrivateEndpointConnectionItem[]

属性值

provisioningState

保管库的预配状态。

provisioningState?: string

属性值

string

publicNetworkAccess

用于指定保管库是否接受来自公共 Internet 的流量的属性。 如果设置为“禁用”除专用终结点流量之外的所有流量,并且源自受信任的服务的所有流量将被阻止。 这将替代设置的防火墙规则,这意味着即使存在防火墙规则,我们也不会遵守这些规则。

publicNetworkAccess?: string

属性值

string

sku

SKU 详细信息

sku: Sku

属性值

Sku

softDeleteRetentionInDays

softDelete 数据保留天数。 它接受 >=7,<=90。

softDeleteRetentionInDays?: number

属性值

number

tenantId

应用于对密钥保管库的请求进行身份验证的 Azure Active Directory 租户 ID。

tenantId: string

属性值

string

vaultUri

用于对密钥和机密执行作的保管库的 URI。

vaultUri?: string

属性值

string