共用方式為


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, public_network_access: str = 'enabled', **kwargs: Any)

僅限關鍵字參數

名稱 Description
tenant_id
str

應該用來驗證金鑰保存庫要求的 Azure Active Directory 租使用者識別碼。 必要。

sku
Sku

SKU 詳細資料。 必要。

access_policies

具有金鑰保存庫存取權的 0 到 1024 身分識別陣列。 陣列中的所有身分識別都必須使用與金鑰保存庫租使用者識別碼相同的租使用者識別碼。 當 設定為 recovercreateMode ,不需要存取原則。 否則,需要存取原則。

vault_uri
str

保存庫的 URI,用於對金鑰和秘密執行作業。

enabled_for_deployment

屬性,指定是否允許 Azure 虛擬機器從金鑰保存庫擷取儲存為秘密的憑證。

enabled_for_disk_encryption

屬性,指定是否允許 Azure 磁片加密從保存庫擷取秘密和解除包裝金鑰。

enabled_for_template_deployment

屬性,指定是否允許 Azure Resource Manager從金鑰保存庫擷取秘密。

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 Resource Manager上的任何原則。 如果為 null 或未指定,則會使用預設值 false 建立保存庫。 請注意,管理動作一律會獲得 RBAC 的授權。

create_mode

保存庫的建立模式,指出保存庫是否需要復原。 已知值為:「recover」 和 「default」。

enable_purge_protection

屬性,指定是否為此保存庫啟用清除保護。 將此屬性設定為 true 可啟用保護,以防止清除此保存庫及其內容, 只有金鑰保存庫服務可能會起始硬式且無法復原的刪除。 只有在同時啟用虛刪除時,此設定才有效。 啟用這項功能是無法復原的,也就是說,屬性不接受 false 做為其值。

network_acls

規則,控管來自特定網路位置之金鑰保存庫的存取範圍。

provisioning_state

保存庫的布建狀態。 已知值為:「Succeeded」 和 「RegisteringDns」。

public_network_access
str

屬性,指定保存庫是否接受來自公用網際網路的流量。 如果設定為 「已停用」所有流量,但私人端點流量除外,且來自受信任服務的流量將會遭到封鎖。 這會覆寫設定的防火牆規則,這表示即使防火牆規則存在,我們也不會接受規則。

預設值: enabled

變數

名稱 Description
tenant_id
str

應該用來驗證金鑰保存庫要求的 Azure Active Directory 租使用者識別碼。 必要。

sku
Sku

SKU 詳細資料。 必要。

access_policies

具有金鑰保存庫存取權的 0 到 1024 身分識別陣列。 陣列中的所有身分識別都必須使用與金鑰保存庫租使用者識別碼相同的租使用者識別碼。 當 設定為 recovercreateMode ,不需要存取原則。 否則,需要存取原則。

vault_uri
str

保存庫的 URI,用於對金鑰和秘密執行作業。

hsm_pool_resource_id
str

HSM 集區的資源識別碼。

enabled_for_deployment

屬性,指定是否允許 Azure 虛擬機器從金鑰保存庫擷取儲存為秘密的憑證。

enabled_for_disk_encryption

屬性,指定是否允許 Azure 磁片加密從保存庫擷取秘密和解除包裝金鑰。

enabled_for_template_deployment

屬性,指定是否允許 Azure Resource Manager從金鑰保存庫擷取秘密。

enable_soft_delete

屬性,指定此金鑰保存庫是否啟用「虛刪除」功能。 如果未在建立新的金鑰保存庫時設定為任何值, (true 或 false) ,則預設會將其設定為 true。 設定為 true 之後,就無法將它還原為 false。

soft_delete_retention_in_days
int

softDelete 資料保留天數。 它接受 > =7 和 < =90。

enable_rbac_authorization

控制資料動作授權方式的屬性。 若為 true,金鑰保存庫將會使用角色型存取控制 (RBAC) 來授權資料動作,並忽略保存庫屬性中指定的存取原則。 若為 false,金鑰保存庫將會使用保存庫屬性中指定的存取原則,而且會忽略儲存在 Azure Resource Manager上的任何原則。 如果為 null 或未指定,則會使用預設值 false 建立保存庫。 請注意,管理動作一律會獲得 RBAC 的授權。

create_mode

保存庫的建立模式,指出保存庫是否需要復原。 已知值為:「recover」 和 「default」。

enable_purge_protection

屬性,指定是否為此保存庫啟用清除保護。 將此屬性設定為 true 可啟用保護,以防止清除此保存庫及其內容, 只有金鑰保存庫服務可能會起始硬式且無法復原的刪除。 只有在同時啟用虛刪除時,此設定才有效。 啟用這項功能是無法復原的,也就是說,屬性不接受 false 做為其值。

network_acls

規則,控管來自特定網路位置之金鑰保存庫的存取範圍。

provisioning_state

保存庫的布建狀態。 已知值為:「Succeeded」 和 「RegisteringDns」。

private_endpoint_connections

與金鑰保存庫相關聯的私人端點連線清單。

public_network_access
str

屬性,指定保存庫是否接受來自公用網際網路的流量。 如果設定為 「已停用」所有流量,但私人端點流量除外,且來自受信任服務的流量將會遭到封鎖。 這會覆寫設定的防火牆規則,這表示即使防火牆規則存在,我們也不會接受規則。