Vault Interface

Package:

com.azure.resourcemanager.keyvault.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-keyvault:2.47.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() Gets an array of 0 to 16 identities that have access to the key vault.
abstract CreateMode	createMode() Get the createMode value.
abstract boolean	enabledForDeployment() Checks whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
abstract boolean	enabledForDiskEncryption() Checks whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
abstract boolean	enabledForTemplateDeployment() Checks whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
abstract KeyAsyncClient	keyClient() Gets an authenticated Key Vault key client.
abstract Keys	keys() Gets the Key Vault key API entry point.
abstract NetworkRuleSet	networkRuleSet() Get the networkAcls value.
abstract PublicNetworkAccess	publicNetworkAccess() Whether the vault can be accessed from public network.
abstract boolean	purgeProtectionEnabled() Checks whether purge protection is enabled for this key vault.
abstract boolean	roleBasedAccessControlEnabled() Checks whether role based access control (RBAC) for authorization of data access is enabled.
abstract SecretAsyncClient	secretClient() Gets an authenticated Key Vault secret client.
abstract Secrets	secrets() Gets the Key Vault secret API entry point.
abstract Sku	sku() Gets SKU details.
abstract boolean	softDeleteEnabled() Gets whether soft delete is enabled for this key vault.
abstract String	tenantId() Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
abstract HttpPipeline	vaultHttpPipeline() Gets an authenticated Key Vault rest client.
abstract String	vaultUri() Gets the URI of the vault for performing operations on keys and secrets.

Method Details

accessPolicies

public abstract List accessPolicies()

Gets an array of 0 to 16 identities that have access to the key vault.

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()

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

Returns:

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

enabledForDiskEncryption

public abstract boolean enabledForDiskEncryption()

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

Returns:

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

enabledForTemplateDeployment

public abstract boolean enabledForTemplateDeployment()

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

Returns:

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

keyClient

public abstract KeyAsyncClient keyClient()

Gets an authenticated Key Vault key client.

Returns:

an authenticated Key Vault key client

keys

public abstract Keys keys()

Gets the Key Vault key API entry point.

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()

Checks whether purge protection is enabled for this key vault.

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()

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

Returns:

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

secretClient

public abstract SecretAsyncClient secretClient()

Gets an authenticated Key Vault secret client.

Returns:

an authenticated Key Vault secret client

secrets

public abstract Secrets secrets()

Gets the Key Vault secret API entry point.

Returns:

the Key Vault secret API entry point

sku

public abstract Sku sku()

Gets SKU details.

Returns:

SKU details.

softDeleteEnabled

public abstract boolean softDeleteEnabled()

Gets whether soft delete is enabled for this key vault.

Returns:

whether soft delete is enabled for this key vault.

tenantId

public abstract String tenantId()

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

Returns:

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

vaultHttpPipeline

public abstract HttpPipeline vaultHttpPipeline()

Gets an authenticated Key Vault rest client.

Returns:

an authenticated Key Vault rest client

vaultUri

public abstract String vaultUri()

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

Returns:

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