Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VaultProperties

Package version

Properties of the vault

Hierarchy

  • VaultProperties

Index

Properties

Optional accessPolicies

accessPolicies: AccessPolicyEntry[]

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.

Optional createMode

createMode: CreateMode

The vault's create mode to indicate whether the vault need to be recovered or not.

Optional enablePurgeProtection

enablePurgeProtection: undefined | false | true

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.

Optional enableRbacAuthorization

enableRbacAuthorization: undefined | false | true

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.

Optional enableSoftDelete

enableSoftDelete: undefined | false | true

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.

Optional enabledForDeployment

enabledForDeployment: undefined | false | true

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

Optional enabledForDiskEncryption

enabledForDiskEncryption: undefined | false | true

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

Optional enabledForTemplateDeployment

enabledForTemplateDeployment: undefined | false | true

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

Optional hsmPoolResourceId

hsmPoolResourceId: undefined | string

The resource id of HSM Pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkAcls

networkAcls: NetworkRuleSet

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

Optional privateEndpointConnections

privateEndpointConnections: PrivateEndpointConnectionItem[]

List of private endpoint connections associated with the key vault. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: VaultProvisioningState

Provisioning state of the vault.

Optional publicNetworkAccess

publicNetworkAccess: undefined | string

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.

sku

sku: Sku

SKU details

Optional softDeleteRetentionInDays

softDeleteRetentionInDays: undefined | number

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

tenantId

tenantId: string

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

Optional vaultUri

vaultUri: undefined | string

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

Generated using TypeDoc