VaultProperties Class

Properties of the vault.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

VaultProperties

Constructor

VaultProperties(*, tenant_id: str, sku: azure.mgmt.keyvault.v2016_10_01.models._models_py3.Sku, access_policies: Optional[List[azure.mgmt.keyvault.v2016_10_01.models._models_py3.AccessPolicyEntry]] = None, vault_uri: Optional[str] = None, enabled_for_deployment: Optional[bool] = None, enabled_for_disk_encryption: Optional[bool] = None, enabled_for_template_deployment: Optional[bool] = None, enable_soft_delete: Optional[bool] = None, create_mode: Optional[Union[str, azure.mgmt.keyvault.v2016_10_01.models._key_vault_management_client_enums.CreateMode]] = None, enable_purge_protection: Optional[bool] = None, **kwargs)

Variables

tenant_id

str

Required. The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

sku

Sku

Required. 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. When createMode is set to recover, access policies are not required. Otherwise, access policies are required.

vault_uri

str

The URI of the vault for performing operations on keys and secrets.

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 specifying whether recoverable deletion is enabled for this key vault. Setting this property to true activates the soft delete feature, whereby vaults or vault entities can be recovered after deletion. Enabling this functionality is irreversible - that is, the property does not accept false as its value.

create_mode

str or CreateMode

The vault's create mode to indicate whether the vault need to be recovered or not. Possible values include: "recover", "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.