Share via


VaultProperties Class

Definition

Properties of the vault

public class VaultProperties
type VaultProperties = class
Public Class VaultProperties
Inheritance
VaultProperties

Constructors

VaultProperties()

Initializes a new instance of the VaultProperties class.

VaultProperties(Guid, Sku, IList<AccessPolicyEntry>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<CreateMode>, Nullable<Boolean>, NetworkRuleSet, IList<PrivateEndpointConnectionItem>)

Initializes a new instance of the VaultProperties class.

Properties

AccessPolicies

Gets or sets 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.

CreateMode

Gets or sets the vault's create mode to indicate whether the vault need to be recovered or not. Possible values include: 'recover', 'default'

EnabledForDeployment

Gets or sets property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

EnabledForDiskEncryption

Gets or sets property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

EnabledForTemplateDeployment

Gets or sets property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

EnablePurgeProtection

Gets or sets 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.

EnableRbacAuthorization

Gets or sets 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 (warning: this is a preview feature). 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.

EnableSoftDelete

Gets or sets 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.

NetworkAcls

Gets or sets rules governing the accessibility of the key vault from specific network locations.

PrivateEndpointConnections

Gets list of private endpoint connections associated with the key vault.

Sku

Gets or sets SKU details

SoftDeleteRetentionInDays

Gets or sets softDelete data retention days. It accepts &gt;=7 and &lt;=90.

TenantId

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

VaultUri

Gets or sets the URI of the vault for performing operations on keys and secrets.

Methods

Validate()

Validate the object.

Applies to