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

VaultProperties 类

保管库的属性。

变量仅由服务器填充,发送请求时将被忽略。

必须填充所有必需的参数才能发送到 Azure。

继承
azure.mgmt.keyvault._serialization.Model
VaultProperties

构造函数

VaultProperties(*, tenant_id: str, sku: _models.Sku, access_policies: List[_models.AccessPolicyEntry] | None = None, vault_uri: str | None = None, enabled_for_deployment: bool | None = None, enabled_for_disk_encryption: bool | None = None, enabled_for_template_deployment: bool | None = None, enable_soft_delete: bool = True, soft_delete_retention_in_days: int = 90, enable_rbac_authorization: bool = False, create_mode: str | _models.CreateMode | None = None, enable_purge_protection: bool | None = None, network_acls: _models.NetworkRuleSet | None = None, provisioning_state: str | _models.VaultProvisioningState | None = None, **kwargs: Any)

仅限关键字的参数

名称 说明
tenant_id
str

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

sku
Sku

SKU 详细信息。 必需。

access_policies

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

vault_uri
str

用于对密钥和机密执行操作的保管库的 URI。 此属性是只读的。

enabled_for_deployment

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

enabled_for_disk_encryption

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

enabled_for_template_deployment

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

enable_soft_delete

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

默认值: True
soft_delete_retention_in_days
int

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

默认值: 90
enable_rbac_authorization

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

create_mode

保管库的创建模式,用于指示是否需要恢复保管库。 已知值为:“recover”和“default”。

enable_purge_protection

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

network_acls

管理来自特定网络位置的密钥保管库可访问性的规则。

provisioning_state

保管库的预配状态。 已知值为:“Succeeded”和“RegisteringDns”。

变量

名称 说明
tenant_id
str

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

sku
Sku

SKU 详细信息。 必需。

access_policies

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

vault_uri
str

用于对密钥和机密执行操作的保管库的 URI。 此属性是只读的。

hsm_pool_resource_id
str

HSM 池的资源 ID。

enabled_for_deployment

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

enabled_for_disk_encryption

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

enabled_for_template_deployment

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

enable_soft_delete

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

soft_delete_retention_in_days
int

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

enable_rbac_authorization

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

create_mode

保管库的创建模式,用于指示是否需要恢复保管库。 已知值为:“recover”和“default”。

enable_purge_protection

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

network_acls

管理来自特定网络位置的密钥保管库可访问性的规则。

provisioning_state

保管库的预配状态。 已知值为:“Succeeded”和“RegisteringDns”。

private_endpoint_connections

与密钥保管库关联的专用终结点连接列表。