VaultPatchProperties Class

Reference

Properties of the vault.

Inheritance: azure.mgmt.keyvault._serialization.Model

VaultPatchProperties

Constructor

VaultPatchProperties(*, tenant_id: str | None = None, sku: _models.Sku | None = None, access_policies: List[_models.AccessPolicyEntry] | 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 | None = None, enable_rbac_authorization: bool | None = None, soft_delete_retention_in_days: int | None = None, create_mode: str | _models.CreateMode | None = None, enable_purge_protection: bool | None = None, network_acls: _models.NetworkRuleSet | None = None, public_network_access: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tenant_id	str The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
sku	Sku SKU details.
access_policies	list[AccessPolicyEntry] An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
enabled_for_deployment	bool Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
enabled_for_disk_encryption	bool Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
enabled_for_template_deployment	bool Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
enable_soft_delete	bool Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false.
enable_rbac_authorization	bool Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change.
soft_delete_retention_in_days	int softDelete data retention days. It accepts >=7 and <=90.
create_mode	str or CreateMode The vault's create mode to indicate whether the vault need to be recovered or not. Known values are: "recover" and "default".
enable_purge_protection	bool Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.
network_acls	NetworkRuleSet A collection of rules governing the accessibility of the vault from specific network locations.
public_network_access	str Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules.

Variables

Name	Description
tenant_id	str The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
sku	Sku SKU details.
access_policies	list[AccessPolicyEntry] An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
enabled_for_deployment	bool Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
enabled_for_disk_encryption	bool Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
enabled_for_template_deployment	bool Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
enable_soft_delete	bool Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false.
enable_rbac_authorization	bool Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change.
soft_delete_retention_in_days	int softDelete data retention days. It accepts >=7 and <=90.
create_mode	str or CreateMode The vault's create mode to indicate whether the vault need to be recovered or not. Known values are: "recover" and "default".
enable_purge_protection	bool Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.
network_acls	NetworkRuleSet A collection of rules governing the accessibility of the vault from specific network locations.
public_network_access	str Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules.

Share via

VaultPatchProperties Class

Constructor

Keyword-Only Parameters

Variables

Additional resources