VaultPatchProperties Class

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, create_mode: str | _models.CreateMode | None = None, enable_purge_protection: bool | 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

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

Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

enabled_for_disk_encryption

Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

enabled_for_template_deployment

Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

enable_soft_delete

Property specifying whether recoverable deletion ('soft' delete) is enabled for this key vault. The property may not be set to false.

create_mode

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

Property specifying whether protection against purge is enabled for this vault; it is only effective if soft delete is also enabled. Once activated, the property may no longer be reset to false.

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

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

Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

enabled_for_disk_encryption

Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

enabled_for_template_deployment

Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

enable_soft_delete

Property specifying whether recoverable deletion ('soft' delete) is enabled for this key vault. The property may not be set to false.

create_mode

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

Property specifying whether protection against purge is enabled for this vault; it is only effective if soft delete is also enabled. Once activated, the property may no longer be reset to false.