VaultPropertiesResponse

data class VaultPropertiesResponse(val accessPolicies: List<AccessPolicyEntryResponse>? = null, val enablePurgeProtection: Boolean? = null, val enableRbacAuthorization: Boolean? = null, val enableSoftDelete: Boolean? = null, val enabledForDeployment: Boolean? = null, val enabledForDiskEncryption: Boolean? = null, val enabledForTemplateDeployment: Boolean? = null, val hsmPoolResourceId: String, val networkAcls: NetworkRuleSetResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionItemResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val sku: SkuResponse, val softDeleteRetentionInDays: Int? = null, val tenantId: String, val vaultUri: String)

Properties of the vault

Constructors

Link copied to clipboard
constructor(accessPolicies: List<AccessPolicyEntryResponse>? = null, enablePurgeProtection: Boolean? = null, enableRbacAuthorization: Boolean? = null, enableSoftDelete: Boolean? = null, enabledForDeployment: Boolean? = null, enabledForDiskEncryption: Boolean? = null, enabledForTemplateDeployment: Boolean? = null, hsmPoolResourceId: String, networkAcls: NetworkRuleSetResponse? = null, privateEndpointConnections: List<PrivateEndpointConnectionItemResponse>, provisioningState: String, publicNetworkAccess: String? = null, sku: SkuResponse, softDeleteRetentionInDays: Int? = null, tenantId: String, vaultUri: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

An array of 0 to 1024 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. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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 vault is created with the default value of false. Note that management actions are always authorized with RBAC.

Link copied to clipboard

Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false.

Link copied to clipboard

The resource id of HSM Pool.

Link copied to clipboard

Rules governing the accessibility of the key vault from specific network locations.

Link copied to clipboard

List of private endpoint connections associated with the key vault.

Link copied to clipboard

Provisioning state of the vault.

Link copied to clipboard

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.

Link copied to clipboard

SKU details

Link copied to clipboard

softDelete data retention days. It accepts >=7 and <=90.

Link copied to clipboard

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

Link copied to clipboard

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