Share via

Vault Interface

  • Reference
Package:
com.azure.resourcemanager.keyvault.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-keyvault:2.44.0

Implements

GroupableResource<KeyVaultManager,VaultInner> SupportsListingPrivateLinkResource SupportsUpdatingPrivateEndpointConnection Refreshable<Vault> Updatable<Update>

public interface Vault
extends GroupableResource<KeyVaultManager,VaultInner>, Refreshable<Vault>, Updatable<Update>, SupportsListingPrivateLinkResource, SupportsUpdatingPrivateEndpointConnection

An immutable client-side representation of an Azure Key Vault.

Method Summary

Modifier and Type Method and Description
abstract List<AccessPolicy> accessPolicies()
abstract CreateMode createMode()

Get the createMode value.
abstract boolean enabledForDeployment()
abstract boolean enabledForDiskEncryption()
abstract boolean enabledForTemplateDeployment()
abstract KeyAsyncClient keyClient()
abstract Keys keys()
abstract NetworkRuleSet networkRuleSet()

Get the networkAcls value.
abstract PublicNetworkAccess publicNetworkAccess()

Whether the vault can be accessed from public network.
abstract boolean purgeProtectionEnabled()
abstract boolean roleBasedAccessControlEnabled()
abstract SecretAsyncClient secretClient()
abstract Secrets secrets()
abstract Sku sku()
abstract boolean softDeleteEnabled()
abstract String tenantId()
abstract HttpPipeline vaultHttpPipeline()
abstract String vaultUri()

Method Details

accessPolicies

public abstract List accessPolicies()

Returns:

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.

createMode

public abstract CreateMode createMode()

Get the createMode value.

Returns:

the createMode value

enabledForDeployment

public abstract boolean enabledForDeployment()

Returns:

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

enabledForDiskEncryption

public abstract boolean enabledForDiskEncryption()

Returns:

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

enabledForTemplateDeployment

public abstract boolean enabledForTemplateDeployment()

Returns:

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

keyClient

public abstract KeyAsyncClient keyClient()

Returns:

an authenticated Key Vault key client

keys

public abstract Keys keys()

Returns:

the Key Vault key API entry point

networkRuleSet

public abstract NetworkRuleSet networkRuleSet()

Get the networkAcls value.

Returns:

the networkAcls value

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the vault can be accessed from public network.

Returns:

whether the vault can be accessed from public network.

purgeProtectionEnabled

public abstract boolean purgeProtectionEnabled()

Returns:

whether purge protection is enabled for this key vault. Purge protection can only be enabled if soft delete is enabled.

roleBasedAccessControlEnabled

public abstract boolean roleBasedAccessControlEnabled()

Returns:

whether role based access control (RBAC) for authorization of data access is enabled.

secretClient

public abstract SecretAsyncClient secretClient()

Returns:

an authenticated Key Vault secret client

secrets

public abstract Secrets secrets()

Returns:

the Key Vault secret API entry point

sku

public abstract Sku sku()

Returns:

SKU details.

softDeleteEnabled

public abstract boolean softDeleteEnabled()

Returns:

whether soft delete is enabled for this key vault.

tenantId

public abstract String tenantId()

Returns:

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

vaultHttpPipeline

public abstract HttpPipeline vaultHttpPipeline()

Returns:

an authenticated Key Vault rest client

vaultUri

public abstract String vaultUri()

Returns:

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

Applies to